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.
- 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.
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.
Adhere to the Code of Conduct.