sphinx-autodoc-fastmcp 0.0.1a30

Sphinx extension for documenting FastMCP tools (cards, badges, cross-refs)

sphinx-autodoc-fastmcp

Sphinx extension that documents FastMCP tools with card-style section entries built from the shared api-* layout regions, plus safety badges, parameter tables, and cross-reference roles.

The shipped output intentionally keeps a section wrapper for stable ToC labels and :tool: / :toolref: behavior, but the inner card, badges, and type rendering now come from sphinx_ux_autodoc_layout, sphinx_ux_badges, and sphinx_autodoc_typehints_gp.

Features

• fastmcp-tool: Renders a tool entry as a section card with shared api-header / api-content regions plus a section target for ToC and {ref} labels.
• fastmcp-tool-input: Parameter table for a tool (place after prose in MyST).
• fastmcp-tool-summary: Summary tables grouped by safety tier.
• Roles: :tool:, :toolref:, :toolicon / :tooliconl / :tooliconr / :tooliconil / :tooliconir:, :badge:

Configuration

In conf.py after sphinx_autodoc_fastmcp is listed in extensions:

fastmcp_tool_modules = [
    "myproject.tools.server_tools",
    "myproject.tools.session_tools",
]
fastmcp_area_map = {
    "server_tools": "sessions",
    "session_tools": "sessions",
}
fastmcp_model_module = "myproject.models"
fastmcp_model_classes = {"SessionInfo", "WindowInfo"}
fastmcp_section_badge_map = {"Inspect": "readonly", "Act": "mutating", "Destroy": "destructive"}
fastmcp_section_badge_pages = {"tools/index", "index"}
fastmcp_collector_mode = "register"  # or "introspect"

See the package docstrings and sphinx_autodoc_fastmcp.setup() for defaults.

Dependencies

• Python 3.10+
• Sphinx 8.1+
• sphinx-ux-badges, sphinx-ux-autodoc-layout, and sphinx-autodoc-typehints-gp are declared dependencies and installed automatically with this package.

sphinx_autodoc_fastmcp automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately to your extensions list.

Documentation

See the full documentation for directive options, role reference, and live tool card demos.

License

MIT