MCP server for reading Sphinx documentation
Project description
pysphinx_mcp
MCP server for browsing, searching, and reading Sphinx documentation sites.
Tools
list_pages(base_url): all pages on a docs siteread_page(base_url, page_path): page content as clean textsearch_docs(base_url, query): full-text search via Sphinx search indexlist_sections(base_url, page_path): heading structure (h1-h4) of a pageget_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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pysphinx_mcp-0.2.0.tar.gz.
File metadata
- Download URL: pysphinx_mcp-0.2.0.tar.gz
- Upload date:
- Size: 10.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bbf070232d3de02af611bd31b3c52c5fdb417a9e75530764cfb974eb48c5962e
|
|
| MD5 |
63a25ba3b7aeee2a2273450b9c706a26
|
|
| BLAKE2b-256 |
4130bb4bc65715ba85caf493a4ebbd52ad6c080dfd7d88305ae84966a112ae91
|
Provenance
The following attestation bundles were made for pysphinx_mcp-0.2.0.tar.gz:
Publisher:
release.yml on vmphase/pysphinx_mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pysphinx_mcp-0.2.0.tar.gz -
Subject digest:
bbf070232d3de02af611bd31b3c52c5fdb417a9e75530764cfb974eb48c5962e - Sigstore transparency entry: 2188739013
- Sigstore integration time:
-
Permalink:
vmphase/pysphinx_mcp@c5a1c749c6c46512e07ce3e24f09a486cea19e1f -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/vmphase
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@c5a1c749c6c46512e07ce3e24f09a486cea19e1f -
Trigger Event:
release
-
Statement type:
File details
Details for the file pysphinx_mcp-0.2.0-py3-none-any.whl.
File metadata
- Download URL: pysphinx_mcp-0.2.0-py3-none-any.whl
- Upload date:
- Size: 20.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa2ca05d13ab4580bbd198766fe19535d70a05042d6b9fc48f8167c3db86b822
|
|
| MD5 |
e1ba48b91ea7bbcdd0f64d2dc378a286
|
|
| BLAKE2b-256 |
a6550d4c32538c533ca95f46fa8273c8d7f34d5e6599dc13668a094367fef759
|
Provenance
The following attestation bundles were made for pysphinx_mcp-0.2.0-py3-none-any.whl:
Publisher:
release.yml on vmphase/pysphinx_mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pysphinx_mcp-0.2.0-py3-none-any.whl -
Subject digest:
fa2ca05d13ab4580bbd198766fe19535d70a05042d6b9fc48f8167c3db86b822 - Sigstore transparency entry: 2188739036
- Sigstore integration time:
-
Permalink:
vmphase/pysphinx_mcp@c5a1c749c6c46512e07ce3e24f09a486cea19e1f -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/vmphase
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@c5a1c749c6c46512e07ce3e24f09a486cea19e1f -
Trigger Event:
release
-
Statement type: