sphinx-mcp

Name	sphinx-mcp JSON
Version	0.1.1 JSON
	download
home_page	None
Summary	Sphinx extension for documenting MCP tools, prompts, resources and resource templates.
upload_time	2025-07-20 12:58:36
maintainer	None
docs_url	None
author	None
requires_python	>=3.12
license	None
keywords	documentation mcp model-context-protocol python3 sphinx sphinx-doc sphinx-documentation sphinx-extension
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) [![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://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/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sphinx-mcp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "documentation, mcp, model-context-protocol, python3, sphinx, sphinx-doc, sphinx-documentation, sphinx-extension",
    "author": null,
    "author_email": "Anirban Basu <anirbanbasu@users.noreply.github.com>",
    "download_url": "https://files.pythonhosted.org/packages/ea/70/e60a0acd1ff2699d3873a0a10c3084c137184ac1053665a1eb6d7ee303e7/sphinx_mcp-0.1.1.tar.gz",
    "platform": null,
    "description": "[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) [![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)\n\n# sphinx-mcp\n\n`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://raw.githubusercontent.com/sphinx-contrib/mcp/master/sphinx-mcp.pdf).\n\n# Limitations\n - The limitations of the extension are documented in the aforementioned PDF.\n - The project itself is in an early stage. It does not contain any testing yet.\n\n# Contributing\n\nInstall [uv](https://docs.astral.sh/uv/getting-started/installation/). Install [`pre-commit`](https://pre-commit.com/) for Git by running `uv sync --all-groups`.\n\nThen enable `pre-commit` by running the following in the directory where you clone this project.\n\n```bash\npre-commit install\n```\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n# License\n\n[BSD 3-Clause](https://choosealicense.com/licenses/bsd-3-clause/).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Sphinx extension for documenting MCP tools, prompts, resources and resource templates.",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [
        "documentation",
        " mcp",
        " model-context-protocol",
        " python3",
        " sphinx",
        " sphinx-doc",
        " sphinx-documentation",
        " sphinx-extension"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "44c92ab0125fe0e4a6a58e08e8e7f6fbb992d234faa26efb70c9f14055e3ffd3",
                "md5": "3ee80d79cf73ba95e1f9aae9a5a26ad6",
                "sha256": "1440060096b8dcc7dcc3a7fd194541a47c30c71d3964922b6d4fcb41acfb7277"
            },
            "downloads": -1,
            "filename": "sphinx_mcp-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ee80d79cf73ba95e1f9aae9a5a26ad6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 7259,
            "upload_time": "2025-07-20T12:58:35",
            "upload_time_iso_8601": "2025-07-20T12:58:35.671189Z",
            "url": "https://files.pythonhosted.org/packages/44/c9/2ab0125fe0e4a6a58e08e8e7f6fbb992d234faa26efb70c9f14055e3ffd3/sphinx_mcp-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ea70e60a0acd1ff2699d3873a0a10c3084c137184ac1053665a1eb6d7ee303e7",
                "md5": "790689a762fad843c9921e4da96fe81f",
                "sha256": "16eac065bd191406f17ff7c30f8cf52da816380829fd3602172a2f26ae21b08c"
            },
            "downloads": -1,
            "filename": "sphinx_mcp-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "790689a762fad843c9921e4da96fe81f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 142353,
            "upload_time": "2025-07-20T12:58:36",
            "upload_time_iso_8601": "2025-07-20T12:58:36.790339Z",
            "url": "https://files.pythonhosted.org/packages/ea/70/e60a0acd1ff2699d3873a0a10c3084c137184ac1053665a1eb6d7ee303e7/sphinx_mcp-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-20 12:58:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "sphinx-mcp"
}