https://github.com/sphinx-contrib/mcp

Sphinx extension for documenting MCP tools, prompts, resources and resource templates.
https://github.com/sphinx-contrib/mcp

documentation mcp model-context-protocol sphinx sphinx-doc sphinx-documentation sphinx-extension

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/sphinx-contrib/mcp
• Owner: sphinx-contrib
• License: bsd-3-clause
• Created: 2025-07-05T11:52:49.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2025-11-10T22:33:40.000Z (7 months ago)
• Last Synced: 2026-02-07T17:20:53.629Z (5 months ago)
• Topics: documentation, mcp, model-context-protocol, sphinx, sphinx-doc, sphinx-documentation, sphinx-extension
• Language: Python
• Homepage: https://pypi.org/project/sphinx-mcp/
• Size: 612 KB
• Stars: 5
• Watchers: 0
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![PyPI](https://img.shields.io/pypi/v/sphinx-mcp?label=pypi%20package)](https://pypi.org/project/sphinx-mcp/#history) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/sphinx-contrib/mcp/latest)

# 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](https://docs.google.com/viewer?url=https://raw.githubusercontent.com/sphinx-contrib/mcp/master/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](https://docs.astral.sh/uv/getting-started/installation/). Install [`pre-commit`](https://pre-commit.com/) for Git by running `uv sync --all-groups`.

Then enable `pre-commit` by running the following in the directory where you clone this project.

```bash

pre-commit install

```

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

# License

[BSD 3-Clause](https://choosealicense.com/licenses/bsd-3-clause/).