Sphinx extension for documenting MCP tools, prompts, resources and resource templates.
Project description
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. It does not contain any testing yet.
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
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_mcp-0.1.2.tar.gz.
File metadata
- Download URL: sphinx_mcp-0.1.2.tar.gz
- Upload date:
- Size: 165.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1d5ca63fbb3c81d2e349ca002b78d06a6f1a6f80ef38b6e47e062949073ca65c
|
|
| MD5 |
9551e0500a41ca56e07beead3e161707
|
|
| BLAKE2b-256 |
05caf3fad4feca4f426a272f4a5e09f576f4c854d4416c8e8608f38e8e5d6e44
|
File details
Details for the file sphinx_mcp-0.1.2-py3-none-any.whl.
File metadata
- Download URL: sphinx_mcp-0.1.2-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c44e58c4fc927b95bb028366179d6506d60db44ee4f9dac23dfc88ffe7da7fb3
|
|
| MD5 |
1ffe026a2207baa1c9c3f6462e19fdce
|
|
| BLAKE2b-256 |
4f6de59bd5d30968a17705240878157d9bf6f41ca792451604183e91d579f8d6
|
