docs: generate hierarchical per-module API reference pages (#2103)

This commit is contained in:
Jonathan Hefner 2026-03-18 13:15:17 -05:00 • committed by GitHub
commit 5388bea53a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 74 additions and 7 deletions

View file

@ -1 +0,0 @@
::: mcp

View file

@ -0,0 +1,35 @@
"""Generate the code reference pages and navigation."""
from pathlib import Path
import mkdocs_gen_files
nav = mkdocs_gen_files.Nav()
root = Path(__file__).parent.parent.parent
src = root / "src"
for path in sorted(src.rglob("*.py")):
module_path = path.relative_to(src).with_suffix("")
doc_path = path.relative_to(src).with_suffix(".md")
full_doc_path = Path("api", doc_path)
parts = tuple(module_path.parts)
if parts[-1] == "__init__":
parts = parts[:-1]
doc_path = doc_path.with_name("index.md")
full_doc_path = full_doc_path.with_name("index.md")
elif parts[-1].startswith("_"):
continue
nav[parts] = doc_path.as_posix()
with mkdocs_gen_files.open(full_doc_path, "w") as fd:
ident = ".".join(parts)
fd.write(f"::: {ident}")
mkdocs_gen_files.set_edit_path(full_doc_path, path.relative_to(root))
with mkdocs_gen_files.open("api/SUMMARY.md", "w") as nav_file:
nav_file.writelines(nav.build_literate_nav())

View file

@ -64,4 +64,4 @@ npx -y @modelcontextprotocol/inspector
## API Reference
Full API documentation is available in the [API Reference](api.md).
Full API documentation is available in the [API Reference](api/mcp/index.md).

View file

@ -883,6 +883,6 @@ The lowlevel `Server` also now exposes a `session_manager` property to access th
If you encounter issues during migration:
1. Check the [API Reference](api.md) for updated method signatures
1. Check the [API Reference](api/mcp/index.md) for updated method signatures
2. Review the [examples](https://github.com/modelcontextprotocol/python-sdk/tree/main/examples) for updated usage patterns
3. Open an issue on [GitHub](https://github.com/modelcontextprotocol/python-sdk/issues) if you find a bug or need further assistance