Skip to content

docs(mcp): document the first-class version and artifact tools - #4969

Open
NiniGeek wants to merge 1 commit into
github:mainfrom
NiniGeek:docs/mcp-reference-tools
Open

NiniGeek wants to merge 1 commit into
github:mainfrom
NiniGeek:docs/mcp-reference-tools

Conversation

@NiniGeek

Copy link
Copy Markdown

Description

docs/reference/mcp.md still describes the version-only server from #4822: three generic tools, only version, and "does not expose ... artifacts". The server now also registers first-class tools that the reference page never mentions:

All three are wired in create_server() (src/specify_cli/mcp_server/server.py).

This PR:

  • lists the first-class tools with their inputs (project_directory, limit 1-1000 default 100, cursor, identifier, kind), results, and error codes, including the retryable 1 MiB response_too_large error;
  • keeps the generic tools and their version-only scope;
  • states that specify artifact lookup is not exposed yet. It is declared unavailable in ARTIFACT_TOOLS and not registered, which tests/specify_cli/artifacts/test_mcp_list.py asserts. refactor(artifact): extract lookup operation聽#4952 will likely change that, and the page can be updated when the tool lands;
  • removes the stale "version-only" wording from docs/reference/overview.md and from the specify mcp docstring that specify mcp --help prints.

Only documentation and one docstring change; no behavior change.

Testing

  • specify mcp --help now prints "Run the experimental MCP server over stdio."
  • Ran the MCP tests in the repo venv (uv sync --extra test, then pytest tests/specify_cli/test_command_mcp.py tests/specify_cli/test_mcp_version.py tests/specify_cli/artifacts/test_mcp_list.py tests/specify_cli/artifacts/test_mcp_info.py tests/specify_cli/mcp_server): 147 passed
  • markdownlint-cli2 on both changed pages: 0 issues
  • Tested with a sample project (not applicable)

Each documented value (limits, error codes, the retryable field, lookup's disposition) was checked against the source cited above.

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (fill in the disclosure below)

AI disclosure: Claude Code (Claude Opus 5.5) found the drift by comparing the reference page with the code. A Claude Sonnet 5.5 sub-agent then wrote the edits (default settings, minimal-diff instructions) and ran the tests and the linter. Opus checked the documented values against the source, and I reviewed the full diff before the commit. Scope: documentation and one docstring, no code generation. This PR description was written by Claude Code on my behalf.

馃 Generated with Claude Code

docs/reference/mcp.md still described the version-only server from
github#4822. The server now also registers specify_version (github#4864),
specify_artifact_list (github#4867) and specify_artifact_info (github#4885).
Document their inputs, results and errors, state that artifact lookup
is not exposed yet, and drop the stale "version-only" wording from the
overview page and the `specify mcp --help` docstring.

Assisted-by: Claude Code (model: Claude Sonnet 5.5, orchestrated by Claude Opus 5.5, supervised)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@NiniGeek
NiniGeek requested a review from mnriem as a code owner October 15, 2026 08:13

This branch has not been deployed

No deployments
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