sphinx-mcp
sphinx-mcp is a Sphinx extension for documenting MCP tools, prompts, resources and resource templates. The documentation of the extension including examples of MCP server documentation is available in the pre-compiled PDF: sphinx-mcp.pdf.
Limitations
- The limitations of the extension are documented in the aforementioned PDF.
- The project itself is in an early stage. Test coverage is limited to a smoke test that builds documentation against a local fixture MCP server; see
tests/.
Contributing
Install uv. Install pre-commit for Git by running uv sync --all-groups.
Then enable pre-commit by running the following in the directory where you clone this project.
pre-commit install
To regenerate the PDF documentation with ./genpdfdoc.sh, you will also need a LaTeX distribution
providing xelatex and latexmk (e.g. texlive-xetex and texlive-latex-base on Debian/Ubuntu),
plus the Noto Sans JP font installed on your
system, since docs/conf.py configures xelatex as the LaTeX engine with Noto Sans JP as the main
font.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
1 maintainer
Metadata
1 maintainer
Release files for sphinx-mcp 0.1.3
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_mcp-0.1.3.tar.gz | 232.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_mcp-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 240.3 kB
Release files / sphinx_mcp-0.1.3.tar.gz
| Download URL | sphinx_mcp-0.1.3.tar.gz |
|---|---|
| Size | 232.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
387cc34b4b3e94bcf6d4c6d8cea2906d98149b1a2eabb0965853bc503fbf688b
|
|
BLAKE2b-256 checksum How to use checksums |
cf17fad91bf1bca9411e4f6fd61a920e2eb68315faa4f029a2bbc3800133faf2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.14 {"installer":{"name":"uv","version":"0.12.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / sphinx_mcp-0.1.3-py3-none-any.whl
| Download URL | sphinx_mcp-0.1.3-py3-none-any.whl |
|---|---|
| Size | 7.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2cf02656f9e29c865b30f7a1d8d6f96fae6f21e77f0691a0e9e05bf9a5e29697
|
|
BLAKE2b-256 checksum How to use checksums |
f0b7b4b171b0ef38dc700ac22b79fa4959de81033bc95328f61781e6e2d10516
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.14 {"installer":{"name":"uv","version":"0.12.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
