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.2.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.2-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pysphinx_mcp-0.2.2.tar.gz
Algorithm Hash digest
SHA256 e83cb707915e07531c1ac9d7575e5a1280598916ffb29a3ab0a527cd8a09069d
MD5 c558dcb419d981a12e41cce27db377a3
BLAKE2b-256 ebb72130b257b34a7c9987be7e9e30cba70680b3c1df42794f93752eb4e77fbc

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysphinx_mcp-0.2.2.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.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pysphinx_mcp-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 973f87bc194eda6762ddacbe13d6e013ac332db7dae5f99ab4362cae12987678
MD5 5f493211f8017202994a974f8e007777
BLAKE2b-256 d390cf8b58f574caebccf796b71983997ef09a4171835fdb3ce2cc8e71625855

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysphinx_mcp-0.2.2-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

This release

0.2.2 This release

2 files

0.2.1

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