docs: correct stale agent-facing references in AGENTS.md and agents index - #3210
docs: correct stale agent-facing references in AGENTS.md and agents index#3210mc856 wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Greptile has paused reviews on this repository — it used its 100 free open-source review credits for this billing period. Reviews resume automatically on August 3. To continue before then, an organization admin can keep reviews running past the free credits — those bill as normal usage.
|
@greptile can you review accuracy |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #3210 +/- ##
==========================================
- Coverage 74.90% 74.62% -0.28%
==========================================
Files 1114 1114
Lines 106086 106086
Branches 9665 9665
==========================================
- Hits 79461 79170 -291
- Misses 23816 24133 +317
+ Partials 2809 2783 -26
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
The |
Contribution path
Problem
AGENTS.mdanddocs/capabilities/agents/index.mdhave drifted from the code. Following themsends you to a source file, a doc path and a prompt section that don't exist, a
pytestpaththat fails, and a blueprint table that names the wrong model and says three agentic blueprints
have no MCP server when all three start one.
Solution
Audited the agent-related statements of both files against
main; changed only what turns outfalse, plus dead references hit on the way (pytest path,
worker_managerline, two doc paths).Style, omissions and the broader overview stay. Three edits are follow-through of a correction —
marked below.
AGENTS.md
mcp_client.py:62); all three composeMcpServer.blueprint()(g1/blueprints/agentic/_agentic_skills.py,manipulators/xarm/blueprints/agentic.py)agents/agent.pyagents/mcp/— note moved there (follow-through)worker_manager_*.py, "Python / docker worker pools"worker_manager.py(a Protocol) andworker_manager_python.py, so the glob lost its underscoreNonereturn → agent hears "It has started…"mcp_client.py:199fires on non-text content;mcp_server.pystr()-ifies anything lackingagent_encode(), soNonearrives as"None"; step 4 updated to match (follow-through)# AVAILABLE SKILLSsectioncore/module.py:448); a shipped skill takeslist[dict[str, float]](gps_nav_skill.py:58)docs/development/dimos_run.md(twice); tree:docs/agents/docs/usage/cli.md; renamed by #2316 — see belowuv run pytest dimos/core/test_blueprints.pydimos/core/coordination/docs/capabilities/agents/index.md
gpt-4o, "Best quality" (twice)mcp_client.py:62; the quality claim went with it (follow-through)WebInput: port 7779, "optional" Whisper STTweb_human_input.pybinds 5555 and constructsWhisperNode()unconditionally; 7779 is theWebsocketVisModuledefaultagent_encode()(SkillResult,Image); the rest isstr()-ified — shipped skills returnbool,dict,PoseStamped, generatorstag_location(name),map_query(query),PersonFollowSkill,GPSNavSkilllocation_name,query_sentence,PersonFollowSkillContainer,GpsNavSkillContainerThe two "Agent system documentation" labels. The label was wrong from day one: at
26e06b7951,docs/agents/index.mdopened with "These docs are mostly for coding agents" —the confusion #2316 names. #2316 renamed the directory and re-pointed the Further Reading line
itself (
7fb373ba5), chasing the rename without revisiting the label; the tree line stillpoints at the removed
docs/agents/. By #2316's own criterion both belong todocs/capabilities/agents/— never linked fromAGENTS.md, whiledocs/coding-agents/islinked twice. I changed the target; if it was deliberate, I'll relabel instead.
Left alone. The architecture blurb/diagram in
index.mdnever matched the old agent moduleeither — that's a rewrite, not a correction. A few falsifiable errors elsewhere in
AGENTS.md(
--viewervalues,DIMOS_prefix, blueprint-run snippet, log path) — happy to sendseparately. #3156 edits the Further Reading line between the two changed here; whichever lands
second needs a one-line rebase.
How to Test
Docs only. The only fenced blocks touched are in
AGENTS.md, whichrun-doc-codeblocksdoesn't walk (it runs on
docs/andREADME.md); no fence inindex.mdchanged. Locally:pre-commit run --from-ref origin/main --to-ref HEADpasses all hooks, and the corrected testpath runs —
uv run pytest dimos/core/coordination/test_blueprints.py -v, 23 passed.AI assistance
Claude Code (Fable 5) and Codex (5.6-Sol) did the audit passes, drafted the corrections and
this text, and cross-reviewed each other's findings. I verified every changed line against
mainand stand behind each one.Checklist