Skip to content

sphinx-contrib/mcp

Contributor Covenant PyPI GitHub commits since latest release

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.

Adhere to the Code of Conduct.

License

BSD 3-Clause.

About

Sphinx extension for documenting MCP tools, prompts, resources and resource templates.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks