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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autodoc_fastmcp-0.1.0a37.tar.gz (28.8 kB view details)

Uploaded Jul 27, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_autodoc_fastmcp-0.1.0a37-py3-none-any.whl (32.6 kB view details)

Uploaded Jul 27, 2026 Python 3

File details

Details for the file sphinx_autodoc_fastmcp-0.1.0a37.tar.gz.

File metadata

Download URL: sphinx_autodoc_fastmcp-0.1.0a37.tar.gz
Upload date: Jul 27, 2026
Size: 28.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_autodoc_fastmcp-0.1.0a37.tar.gz
Algorithm	Hash digest
SHA256	`3c44e874a34371b0aa6f24bdc5a6629c5f8fd732fd306dd8b9494d5f1a1a8ec4`
MD5	`0db4e98291f18d14740eae7a6540d670`
BLAKE2b-256	`4c5182b02636d5e3cf0441174b500874fda415ffba22a24d6d6dd3f8a4f0245c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_fastmcp-0.1.0a37.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_autodoc_fastmcp-0.1.0a37.tar.gz
- Subject digest: 3c44e874a34371b0aa6f24bdc5a6629c5f8fd732fd306dd8b9494d5f1a1a8ec4
- Sigstore transparency entry: 2256729633
- Sigstore integration time: Jul 27, 2026
Source repository:
- Permalink: git-pull/gp-sphinx@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Branch / Tag: refs/tags/v0.1.0a37
- Owner: https://github.com/git-pull
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Trigger Event: push