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

Metadata

Release files for sphinx-autodoc-fastmcp 0.1.0a38

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-autodoc-fastmcp 0.1.0a38
File	Size	Uploaded
sphinx_autodoc_fastmcp-0.1.0a38.tar.gz	32.8 kB	Aug 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-autodoc-fastmcp 0.1.0a38
File	Interpreter	ABI	Platform	Reset
sphinx_autodoc_fastmcp-0.1.0a38-py3-none-any.whl 36.7 kB Aug 30, 2026	Python 3	none	any	Details

Total release size: 69.6 kB

Release files / sphinx_autodoc_fastmcp-0.1.0a38.tar.gz

Download URL	sphinx_autodoc_fastmcp-0.1.0a38.tar.gz
Size	32.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`d92622a3cf54982daa36efa00bb7f07d06e29ca64673e1f2cb3de748d39415b7`
BLAKE2b-256 checksum How to use checksums	`91f8a773f21c4cb87cbb0a8c61e4a35067d689ca8d3571eed6212b3f185ae1cf`
Upload date	Aug 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/git-pull/gp-sphinx
Publishing commit: github.com/git-pull/gp-sphinx/tree/a495917a2a867538a6c7c3254ff887d54b27eb7e

Workflow

Publishing configuration: github.com/git-pull/gp-sphinx/blob/a495917a2a867538a6c7c3254ff887d54b27eb7e/.github/workflows/release.yml
Publishing logs: github.com/git-pull/gp-sphinx/actions/runs/33315953442/attempts/1

Artifact

Subject: sphinx_autodoc_fastmcp-0.1.0a38.tar.gz
SHA-256 checksum: d92622a3cf54982daa36efa00bb7f07d06e29ca64673e1f2cb3de748d39415b7 Verifying attestations

Release files / sphinx_autodoc_fastmcp-0.1.0a38-py3-none-any.whl

Download URL	sphinx_autodoc_fastmcp-0.1.0a38-py3-none-any.whl
Size	36.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`39c6173d06d51158e7a8df4f3532cfb80284455badb981f41da5c96801289db2`
BLAKE2b-256 checksum How to use checksums	`4c75fdf982ec19eb9b7b0ebec5254558dc5880b83882b79e887750b445ed6ec1`
Upload date	Aug 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/git-pull/gp-sphinx
Publishing commit: github.com/git-pull/gp-sphinx/tree/a495917a2a867538a6c7c3254ff887d54b27eb7e

Workflow

Publishing configuration: github.com/git-pull/gp-sphinx/blob/a495917a2a867538a6c7c3254ff887d54b27eb7e/.github/workflows/release.yml
Publishing logs: github.com/git-pull/gp-sphinx/actions/runs/33315953442/attempts/1

Artifact

Subject: sphinx_autodoc_fastmcp-0.1.0a38-py3-none-any.whl
SHA-256 checksum: 39c6173d06d51158e7a8df4f3532cfb80284455badb981f41da5c96801289db2 Verifying attestations