Skip to main content

pysphinx_mcp

MCP server for browsing, searching, and reading Sphinx documentation sites.

PyPI Python License

Tools

  • list_pages(base_url): all pages on a docs site
  • read_page(base_url, page_path): page content as clean text
  • search_docs(base_url, query): full-text search via Sphinx search index
  • list_sections(base_url, page_path): heading structure (h1-h4) of a page
  • get_api_signature(base_url, object_path): signature, parameters, and docstring for a class or function

Install

pip install -U pysphinx_mcp

Usage

As an MCP server

Register with any MCP host:

{
    "mcpServers": {
        "sphinx-docs": {
            "command": "python",
            "args": ["-m", "pysphinx_mcp"]
        }
    }
}

As a library

Each tool is an async function, import and call from your own code:

from pysphinx_mcp import search_docs, read_page, get_api_signature

async def main():
    results = await search_docs(
        "https://docs.python.org/3/",
        "async await",
    )

    content = await read_page(
        "https://docs.python.org/3/",
        "library/asyncio.html",
    )

    signature = await get_api_signature(
        "https://docs.python.org/3/",
        "asyncio.gather",
    )

Composing with other servers

Import the FastMCP instance for mounting or wrapping:

from pysphinx_mcp import mcp

parent_server.mount(mcp)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysphinx_mcp-0.2.1.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pysphinx_mcp-0.2.1-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file pysphinx_mcp-0.2.1.tar.gz.

File metadata

  • Download URL: pysphinx_mcp-0.2.1.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pysphinx_mcp-0.2.1.tar.gz
Algorithm Hash digest
SHA256 af2b60dad3f7c252f66209cd06538d6ebf2a99a578e3352bd31580e4ec60c2da
MD5 38f33b4936aa7e6627322b1ac0861b6a
BLAKE2b-256 8ae6f70b892ad335b124b15ee32bf28a6bd6d0653061a8ab8d56f9ae52cd4a5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysphinx_mcp-0.2.1.tar.gz:

Publisher: release.yml on vmphase/pysphinx_mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pysphinx_mcp-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: pysphinx_mcp-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pysphinx_mcp-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7cd1c98a40a9178b9854a6ed5e4d11df82bc32f97b3c3e3ea0b83d98a4ea2358
MD5 c28cab576976e488fe36b28b58bb56f8
BLAKE2b-256 b89b5f6fe58c3813551ea82056989df1b803484138fc9272c57d7874d8b7aa07

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysphinx_mcp-0.2.1-py3-none-any.whl:

Publisher: release.yml on vmphase/pysphinx_mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.2

2 files

This release

0.2.1 This release

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page