Skip to content

fix(algobot-cli): doc corrections#17

Open
maximenathan wants to merge 3 commits intomainfrom
algobot-cli-corrections
Open

fix(algobot-cli): doc corrections#17
maximenathan wants to merge 3 commits intomainfrom
algobot-cli-corrections

Conversation

@maximenathan
Copy link
Copy Markdown

@maximenathan maximenathan commented May 7, 2026

What does this skill do?

Three documentation corrections to the existing algobot-cli skill. no new skill, no behavior change. Verified against algobot@2.0.0 (latest published on npm) and the running production Agent Studio API.

What's wrong today

File Fix
references/commands.md agents patch / providers patch flag is --json, not --file.
references/config-as-code.md agent-config.json example was stale: uses a top-level indexName (silently stripped on submit) and a placeholder tools: [...]. New shape: each tool needs name + indices: [{index, description}] for algolia_search_index.
SKILL.md (Gotchas) Two failure modes look like "agent not found" but aren't: completions URL has no /agent-studio prefix and requires compatibilityMode; agents create --provider <name> doesn't actually link the provider; needs an agents patch --json '{providerId: <uuid>}' step between create and publish.

Checklist

  • `python3 scripts/validate_skills.py .` passes (0 errors)
  • Skill description is under 1024 chars and includes WHEN and WHEN NOT to trigger — N/A, no description change
  • `evals/evals.json` exists with at least 1 realistic prompt — N/A, docs-only
  • Skill is self-contained — no `../other-skill/` references
  • Registered in `.claude-plugin/marketplace.json` (new skills only) — N/A, existing skill
  • Goes in `skills/` here if useful to customers; internal-only skills → `algolia/internal-skills`

Verified against algobot 2.0.0 (latest): both 'agents patch --help'
and 'providers patch --help' show '--json <file>'. There is no --file
option.
Show the current 'algolia_search_index' tool shape: tools[].name +
tools[].indices array of {index, description}. Replaces the
placeholder 'tools: [...]' and the stale top-level 'indexName' field.

Top-level 'indexName' is silently stripped by the API on submit and
does not appear on the stored agent — verified by POSTing a config
with both root-level indexName and the new tool shape, then reading
back via 'agents get'.
Two failure modes that look like 'agent not found' but aren't:

1. The completions URL has no '/agent-studio' path prefix. With the
   wrong path, the API returns 404 {detail: 'Not Found'} — identical
   to a missing-agent error. The compatibilityMode query param is
   also required (omitting it returns 422 ValidationError). Verified
   against the running prod endpoint.

2. 'agents create --provider <name>' does not actually link the
   provider to the agent. The agent stays draft with providerId:null
   and 'agents publish' 409s with 'Cannot publish without a model or
   provider.' Workaround verified: 'agents patch <id> --json'
   with {providerId: <uuid>} between create and publish.
@maximenathan maximenathan self-assigned this May 7, 2026
@maximenathan maximenathan requested a review from PLNech May 7, 2026 08:38
@maximenathan maximenathan changed the title Algobot cli corrections fix(algobot-cli): doc corrections May 7, 2026
@maximenathan maximenathan marked this pull request as ready for review May 7, 2026 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant