Context
Goal
Make every public-facing surface consistently describe the six-tool surface
(including compare_versions) and codify the refresh as a release-cycle step.
Acceptance criteria
Scope boundaries
In scope: the README registry/version badge, README.md body below the hero (the ## Tools table and prose tool counts), glama.json description, and one checklist line in .github/RELEASE.md.
Out of scope (stop and comment if required):
- The
README.md hero section (everything above the first install code block) — forbidden territory except the stale registry/version badge explicitly called out in the acceptance criteria.
pyproject.toml — the PyPI short description and [project] metadata derive from here and are forbidden. If the short description is stale, comment, do not edit.
server.json version / package versions — release-managed, not part of this doc refresh.
- The line
all five versions in .github/INTEGRATION-TEST.md — that refers to the five Python versions (3.10–3.14), not five tools. Do not "fix" it.
Forbidden-territory reminders (pipeline §2)
README.md hero section — do not touch.
pyproject.toml [project] — do not touch.
- This PR will touch
README.md, .github/RELEASE.md, and glama.json, all of which are CODEOWNERS-owned. Expect required maintainer review; that is correct, not a defect.
Validation commands (pipeline §5)
uv run ruff check src/ tests/
uv run pyright src/
uv run pytest --tb=short -q
uv run python-docs-mcp-server doctor
# README/metadata consistency is exercised by:
uv run pytest tests/test_packaging.py -q
PR template & recovery
- Use
.github/PULL_REQUEST_TEMPLATE/agent.md. Under "Why this triggered human review", note: "Touches CODEOWNERS-owned brand/release docs (README.md, .github/RELEASE.md); opened for review, not auto-merge."
- Blocked? Stop,
WORKING-NOTES.md, comment per §8.
Effort estimate
~1 hour.
Context
.planning/agent-context/readme-glama-six-tool-refresh.mdAGENT-EXECUTION-PIPELINE.mdSTRATEGIC-ROADMAP-2026-05-29.md§3, §4 (v0.3.0), decision 5.9 (this becomes a release-cycle discipline)src/mcp_server_python_docs/server.py(@mcp.toolorder)Goal
Make every public-facing surface consistently describe the six-tool surface
(including
compare_versions) and codify the refresh as a release-cycle step.Acceptance criteria
README.md## Toolssection lists exactly six rows, includingcompare_versions, in the same order as the@mcp.tooldeclarations inserver.py(search_docs, get_docs, lookup_package_docs, list_versions, detect_python_version, compare_versions). Verify: the six tool names appear once each in the table.MCP%20Registry-v0.1.4badge inREADME.mdis updated to the current published registry version (0.2.1) or made version-agnostic; no badge advertises a version older than the latest release. This is the only allowed edit above the first install code block.grep -rin 'five tools\|5 tools\|exposes five' README.md glama.json server.jsonreturns zero hits.glama.jsondescriptionis accurate for the current surface and does not contradict the 6-tool README..github/RELEASE.mdgains a checklist line establishing decision 5.9: "Refresh README## Tools,glama.json, and registry/version badges to match the current tool surface." (one line; existing content untouched.)Scope boundaries
In scope: the README registry/version badge,
README.mdbody below the hero (the## Toolstable and prose tool counts),glama.jsondescription, and one checklist line in.github/RELEASE.md.Out of scope (stop and comment if required):
README.mdhero section (everything above the first install code block) — forbidden territory except the stale registry/version badge explicitly called out in the acceptance criteria.pyproject.toml— the PyPI short description and[project]metadata derive from here and are forbidden. If the short description is stale, comment, do not edit.server.jsonversion/ package versions — release-managed, not part of this doc refresh.all five versionsin.github/INTEGRATION-TEST.md— that refers to the five Python versions (3.10–3.14), not five tools. Do not "fix" it.Forbidden-territory reminders (pipeline §2)
README.mdhero section — do not touch.pyproject.toml [project]— do not touch.README.md,.github/RELEASE.md, andglama.json, all of which are CODEOWNERS-owned. Expect required maintainer review; that is correct, not a defect.Validation commands (pipeline §5)
uv run ruff check src/ tests/ uv run pyright src/ uv run pytest --tb=short -q uv run python-docs-mcp-server doctor # README/metadata consistency is exercised by: uv run pytest tests/test_packaging.py -qPR template & recovery
.github/PULL_REQUEST_TEMPLATE/agent.md. Under "Why this triggered human review", note: "Touches CODEOWNERS-owned brand/release docs (README.md,.github/RELEASE.md); opened for review, not auto-merge."WORKING-NOTES.md, comment per §8.Effort estimate
~1 hour.