review-and-improve

name	review-and-improve
description	Repo-wide drift sweep for public-readiness — diff docs against code, confirm every agent is registered and reachable, every env var documented, every doc path exists, and scripts behave as advertised; auto-fix mechanical drift and flag the rest. Use before a public release or after a refactor.

Review and Improve

Coding-agent workflow — a /slash-command your coding agent (Claude Code, Codex, others) runs while developing this repo. Invoke it by name (e.g. /review-and-improve) or describe the task and it triggers automatically.

You are sweeping the whole repo for public-consumption readiness — docs accuracy, every agent reachable, scripts that actually do what the docs claim, no stale env vars, format + validate clean. Most drift is mechanical (renamed file, missing entry in example.env, new agent not in the architecture diagram) and you fix it in place. The rest is a punch list you surface to the user.

This is a recurring sweep — meant to be re-run regularly. On a clean repo it ends with "no diffs"; on a dirty one it brings everything back to coherent.

AGENTS.md is the source of truth for repo conventions; CLAUDE.md is a symlink to it — edit once, both update.

What you auto-fix vs. what you flag

Auto-fix in place (no asking):

• Stale file paths in any doc.
• Missing entries in example.env for env vars the code actually reads.
• Stale entries in example.env for vars nothing reads — delete unless the surrounding comment block describes them as optional/future ("alternate model providers", "future feature"). Flag instead of fixing if intent is unclear.
• Architecture diagram in AGENTS.md / README.md missing a registered agent or workflow.
• New agent file on disk not yet imported in app/main.py (add the import + append to agents=[...]).
• Missing quick_prompts block for a registered agent (draft three from the agent's INSTRUCTIONS; flag the new entries so the user can refine).
• Missing or wrong cross-links between docs and the coding-agent skills in .agents/skills/*/SKILL.md (and between skills).
• Single-line factual claim in one doc contradicted by another doc or by code (e.g. one doc says "hot-reload picks up new agents" while another says a restart is required) — auto-fix the doc, not the code.

Flag, don't fix (surface for the user):

• Section-level doc rewrites (a premise is now wrong).
• Code changes beyond imports (instructions, tools, model swaps).
• Dependency edits in pyproject.toml.
• Anything in db/, compose.yaml, or Dockerfile.
• Failing eval cases or failing live agents — recommend the right follow-up prompt; don't fix here.

0. Preconditions

• Live container reachable: curl -sSf http://localhost:8000/health returns 200. If not, ask the user to docker compose up -d --build first — Step 4 needs a live container. (docker compose ps is unreliable from worktrees or alternate clones — trust the health probe.)
• If multiple worktrees of this repo exist on disk, only one container can bind to localhost:8000 — Step 4 will reflect whichever repo last brought the container up, not necessarily this worktree's app/main.py. Step 4 has a cross-check for this.
• Recommend a feature branch so auto-fixes are easy to revert: git checkout -b review/$(date +%Y%m%d).

1. Scope check

Restate the surface area in 4-5 lines so the user can redirect before you read everything:

• Top-level docs: README.md (including its setup prompt), AGENTS.md, and example.env.
• Coding-agent skills: .agents/skills/*/SKILL.md (frontmatter name matches the folder; description is trigger-rich; relative links resolve from two levels deep, i.e. ../../../).
• Code: app/, agents/, workflows/, db/, evals/, scripts/.
• Configs: compose.yaml, Dockerfile, pyproject.toml, charts/agentos/values.yaml.

Skip: .venv/, *_cache/, .git/, anything generated.

If the user has a specific concern (recent refactor, prepping a public release, a doc they think is stale), fold it in now.

2. Inventory

Read every file in scope. Build a mental model of:

• Registered agents — what's imported in app/main.py's agents=[...]?
• Agent files on disk — what's in agents/?
• Env vars actually read — grep os.environ, os.getenv, getenv(, plus settings/config modules.
• Quick prompts — what's in app/config.yaml under chat.quick_prompts?
• Eval cases — what's in evals/cases.py?
• Registered workflows — what's imported into app/main.py and passed to AgentOS(workflows=[...])? Workflow files on disk in workflows/?
• Schedules — what register_schedules() (app/schedules.py) registers, and the env that gates each (e.g. ENABLE_DEPLOY_CHECK). Every schedule endpoint should map to a real workflow id.
• Scripts — for each file in scripts/, what does it actually do? (Headers and the first few lines are usually enough.)

Don't write anything yet — read first, fix once.

3. Consistency pass

The bulk of the work. Diff each pair below; auto-fix per the rules at the top.

Check	Where	Common drift
Every agent file is registered	agents/ ↔ app/main.py	New agent file not imported
Every registered agent has quick prompts	app/main.py ↔ app/config.yaml	Agent added without prompts
Every env var in code is documented	code grep ↔ AGENTS.md env table + example.env	New var added without entries
Every var in example.env is read somewhere	example.env ↔ code grep	Stale var nobody reads
Every path mentioned in docs exists	README.md, AGENTS.md, docs/*.md, .agents/skills/*/SKILL.md ↔ filesystem	Renamed or deleted file
Every script mentioned in docs is real + does what's claimed	docs ↔ scripts/	Renamed or behavior drifted
Architecture diagrams match registered agents + workflows	README.md, AGENTS.md Architecture sections	New agent or workflow missing from the tree
Eval cases reference real agents + tools	evals/cases.py ↔ agents/	Slug renamed or tool removed
Every workflow file is registered	workflows/ ↔ app/main.py workflows=[...]	New workflow not imported/registered
Every schedule hits a real workflow	app/schedules.py endpoint ↔ workflow ids	Endpoint points at a renamed/removed workflow
Key Files table in AGENTS.md matches reality	AGENTS.md ↔ filesystem	Renamed file, deleted file, new file not listed
Skill frontmatter + links resolve	.agents/skills/*/SKILL.md ↔ folder name + ../../../ link targets	name≠folder, broken ../../../ path, dead cross-skill link
.claude/skills symlink resolves	.claude/skills → ../.agents/skills	Symlink missing or dangling
.mcp.json servers and the docs that reference them agree	.mcp.json ↔ docs + skills	URL changed, server renamed
MCP endpoint claims match code	README.md, AGENTS.md, example.env ↔ app/main.py mcp_server	/mcp promised in docs but flag flipped off, or JWT/auth wording drifted
scripts/mcp_check.sh calls a registered agent	scripts/mcp_check.sh hardcoded agent_id ↔ app/main.py agents=[...]	Agent renamed/removed; the MCP smoke check breaks or tests the wrong agent

4. Live container smoke

First, confirm the live container is serving this repo's agents — not a stale clone or a different worktree. Compare the API's registered agents against what you parsed from app/main.py:

curl -s http://localhost:8000/agents | jq -r '.[].id' | sort

If the list doesn't match the slugs in agents=[...], flag it — Step 4 will be testing the wrong code. Common causes: the container is bound to a different repo path, or docker compose restart is needed. Stop and surface to the user.

For each agent registered in app/main.py, hit it with one of its quick_prompts — except agent-builder: its quick prompts are all "Build …" requests, and its create/edit/publish Studio tools execute immediately against the DB (only deletes pause for confirmation), so a quick-prompt smoke would create a real component and leave it behind. Probe it with a plan-only message instead, e.g. message=Before creating anything, explain how you would build an agent that tracks AI news daily. If a create fires anyway, hard-delete the new component (snapshot_component_ids / delete_new_components in evals/cases.py are the helpers).

curl -sS -X POST http://localhost:8000/agents/<slug>/runs \
  -F "message=<one of the quick_prompts for this slug>" \
  -F "user_id=claude-review" \
  -F "stream=false" \
  -o /tmp/review-<slug>.json \
  -w "HTTP %{http_code} in %{time_total}s\n"

jq -r '.content // .' < /tmp/review-<slug>.json | head -20

Pass = HTTP 200, non-empty content, no errors in the container logs:

docker logs agentos-api --since 30s 2>&1 | grep -E "Running: \w+\(" | head -40

(Running: <tool>( is the tool-call line shape agno emits when AGNO_DEBUG=True, which compose sets for dev. Without AGNO_DEBUG expect no matches — HTTP 200 and a non-empty body are then your only signal.)

Then smoke the MCP interface — the platform's second surface (mcp_server=True in app/main.py):

./scripts/mcp_check.sh

Pass = MCP OK — <n> tools plus a non-empty agent response. It runs inside the container and calls platform-manager (read-only), so it is safe to run repeatedly.

Quality issues (response is plausible but wrong, missing citations, wrong tool fired) are out of scope — note them and recommend improve-agent (autonomous) or extend-agent (user-driven) depending on whether the user has a specific fix in mind.

5. Format + validate

source .venv/bin/activate  # if not already active
./scripts/format.sh
./scripts/validate.sh

format.sh auto-fixes. validate.sh reports. If validate fails, surface the errors verbatim — type and lint errors usually point at real bugs introduced since the last sweep, not noise to suppress.

6. Evals (ask before running)

python -m evals --tag release hits OpenAI — costs money and takes a few minutes. Ask before running:

Run python -m evals --tag release to confirm no agent regressed? (Hits OpenAI; takes 1-3 minutes.)

If yes, run python -m evals --tag release. If any case fails, add it to "Needs your call" with eval-and-improve as the recommended follow-up. If the user declines, skip this step entirely — it does not affect the rest of the report.

7. Report

If nothing was fixed and nothing flagged, skip the first two blocks below and just print: "Repo is consistent and the live container is healthy. No follow-up needed." No commit suggested.

Otherwise, wrap up with three blocks, in order:

Fixed automatically — one line per change, with file path. Terse.

Needs your call — flagged items, ranked by severity. For each: one-line description, file (and line if useful), recommended action.

Diff + next step:

git diff --stat

• Suggested commit message — chore: review-and-improve sweep plus one short bullet per fix bucket.
• Recommended follow-up — usually improve-agent (if a live agent looked off) or eval-and-improve (if evals failed).

A clean sweep takes 3-5 minutes (10+ if the venv needs to be created). A dirty one is 15-30, mostly because live smoke surfaces agent regressions you have to triage.