Skip to content

docs(agents): trim duplicated tool-surface and parameter docs - #1387

Merged
clouatre merged 1 commit into
mainfrom
feat/session-doc-trim-agents-md-20260810
Aug 10, 2026
Merged

docs(agents): trim duplicated tool-surface and parameter docs#1387
clouatre merged 1 commit into
mainfrom
feat/session-doc-trim-agents-md-20260810

Conversation

@clouatre

Copy link
Copy Markdown
Member

Trim duplicated tool-surface and parameter docs from AGENTS.md.

The "Seven MCP tools" list and the entire "Tool parameters" section restated content already available in the MCP tool descriptions and the JSON schemas generated for each tool. Keeping them in AGENTS.md meant two sources of truth that would silently drift the moment a handler changed.

Changes:

  • Replace the seven-tool family summary with a one-line pointer to the tool descriptions and the handler file location.
  • Drop the ## Tool parameters section (twelve bullets of INVALID_PARAMS and cursor/cache/circuit-breaker notes already enforced by the type module and surfaced by the tool descriptions).

Net effect: -20 lines, +1 line. No code, no test, no behaviour change. Pure docs.

Linked AGENTS.md guidance: project conventions stay; the tool surface is owned by the tools themselves.

The seven-tool summary and the full Tool parameters section restated
content already available in the MCP tool descriptions and JSON
schemas. Replace the tool family list with a pointer to the tool
descriptions themselves; drop the parameter constraints block so it
is not silently out of date when handlers change.

Signed-off-by: Hugues Clouâtre <hugues@linux.com>
@clouatre
clouatre marked this pull request as ready for review August 10, 2026 15:06
@clouatre
clouatre merged commit b1f327d into main Aug 10, 2026
12 checks passed
@clouatre
clouatre deleted the feat/session-doc-trim-agents-md-20260810 branch August 10, 2026 15:06
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