Skip to content

docs: add versions to catalog descriptions in AGENTS.md and mcp-author.md#1479

Merged
jamesadevine merged 1 commit into
mainfrom
docs/catalog-versions-description-6025efc306173262
Jul 13, 2026
Merged

docs: add versions to catalog descriptions in AGENTS.md and mcp-author.md#1479
jamesadevine merged 1 commit into
mainfrom
docs/catalog-versions-description-6025efc306173262

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Agent Documentation Update

Findings

Area Issue File(s)
accuracy catalog command/tool descriptions omit the versions category AGENTS.md, docs/mcp-author.md

Applied Fixes

  • AGENTS.md line 170: catalog.rs module description now lists all six catalog categories — safe-outputs, runtimes, tools, engines, models, pinned versions — instead of the vague (tools, runtimes, models, etc.).
  • docs/mcp-author.md table row for catalog: description updated from "engines, and models" to "engines, models, and pinned versions", matching the tool's actual description string in src/mcp_author/mod.rs.

Notes

The versions category emits the compiler's pinned semver versions for copilot_cli, awf, and mcpg — used by CI to read version pins without scraping Rust source (e.g. ado-aw catalog --kind versions --json | jq -r '.versions.copilot_cli'). It was accurately documented in docs/cli.md but omitted from the two files above.

Verified against:

  • src/inspect/catalog.rsmodels(), engines(), and CatalogResult struct
  • src/mcp_author/mod.rsCatalogParams doc comment and catalog tool description string
  • docs/cli.md — already accurate reference: --kind <safe-outputs|runtimes|tools|engines|models|versions>

Created by the agent-documentation maintainer workflow.

Generated by Agent Documentation Maintainer · 232.5 AIC · ⌖ 11.8 AIC · ⊞ 8.4K ·

…hor.md

The catalog command/tool exposes a 'versions' category that emits the
compiler's pinned semver versions (copilot_cli, awf, mcpg). This was
accurately documented in docs/cli.md but omitted from:

- AGENTS.md: catalog.rs module description listed "(tools, runtimes,
  models, etc.)" — now lists all six categories explicitly.
- docs/mcp-author.md: catalog tool row said "engines, and models" —
  now says "engines, models, and pinned versions" matching the source
  tool description in src/mcp_author/mod.rs.

Verified against src/inspect/catalog.rs models() / engines() functions
and the CatalogParams comment in src/mcp_author/mod.rs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine marked this pull request as ready for review July 13, 2026 09:43
@jamesadevine jamesadevine merged commit 4205fa3 into main Jul 13, 2026
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