This release is a pre-release and may not be stable for production use.
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 sharedapi-header/api-contentregions 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, andsphinx-autodoc-typehints-gpare 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
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autodoc-fastmcp 0.1.0a39
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_autodoc_fastmcp-0.1.0a39.tar.gz | 42.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_autodoc_fastmcp-0.1.0a39-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 89.1 kB
Release files / sphinx_autodoc_fastmcp-0.1.0a39.tar.gz
| Download URL | sphinx_autodoc_fastmcp-0.1.0a39.tar.gz |
|---|---|
| Size | 42.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
508554b0a429cd8515b6b7a56211a10a18ff7d6fc1fc0bf3af62beca9484b379
|
|
BLAKE2b-256 checksum How to use checksums |
f03c66f371ac5e09edf2daf0c551ac7e564034fd1c72413c98397b2439378ae6
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency logRelease files / sphinx_autodoc_fastmcp-0.1.0a39-py3-none-any.whl
| Download URL | sphinx_autodoc_fastmcp-0.1.0a39-py3-none-any.whl |
|---|---|
| Size | 46.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
77bb20fd1c9e0b1274efbc57c14a7cc2c624d2f99d1a45c4e7c8f8dce4aa9fcc
|
|
BLAKE2b-256 checksum How to use checksums |
42eb7244da585b67ef04aa11adcaa23a874728b60a0c3fdbf464071c39802535
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency log
