mofox-docs-mcp
Neo-MoFox 官方文档 MCP 服务器：通过 Model Context Protocol 提供 MoFox-Bot-Docs 文档站的检索与阅读能力，供 Claude、Cursor、Neo-MoFox 等 MCP 客户端直接搜索与阅读官方文档。
数据源为文档站 JSON API（https://docs.mofox-sama.com/api/docs/*），与 MoFox 插件市场中的 mofox_docs 插件共用同一套 llms.json 索引，行为一致。
功能
工具 Tools
| 工具 | 说明 |
|---|---|
search_docs(query, limit?, offset?) |
按关键词检索文档。查询按空白拆词，按「命中关键词数量」降序返回（如 "Windows 部署 安装" 会优先命中 guides/deployment/deployment_guide）。支持分页 |
list_docs(limit?, offset?) |
列出文档。按 section 排序，部署指南（guides/deployment）排最前，每篇含 title / description / preview / section |
get_doc(doc_id) |
获取指定文档完整正文（纯文本）。doc_id 形如 guides/deployment/deployment_guide |
资源 Resources
| 资源 | 说明 |
|---|---|
mofox://docs |
全量索引（llms.json，含每篇的标题 / 简介 / 正文预览） |
mofox://docs/{id} |
单篇文档完整内容（如 mofox://docs/guides/configuration/bot_config_guide） |
快速开始
方式一：uvx 直接运行（推荐）
uvx mofox-docs-mcp
或使用 pipx：
pipx run mofox-docs-mcp
方式二：pip 安装后运行
pip install mofox-docs-mcp
mofox-docs-mcp
方式三：克隆 / 本地构建
uv sync # 或 pip install -e .
uv run mofox-docs-mcp
接入 Neo-MoFox
编辑 config/mcp.toml：
[mcp.stdio_servers.mofox-docs]
command = "uvx"
args = ["mofox-docs-mcp"]
instructions = "提供 Neo-MoFox 官方文档的搜索与阅读功能，当用户询问框架功能、配置、插件开发、API 用法时使用"
重启 Neo-MoFox 即可生效。
其他 MCP 客户端
{
"mcpServers": {
"mofox-docs": {
"command": "uvx",
"args": ["mofox-docs-mcp"]
}
}
}
配置选项
| 参数 | 说明 | 默认值 |
|---|---|---|
--base-url <url> |
文档站地址 | https://docs.mofox-sama.com |
--timeout <秒> |
请求超时 | 30 |
--cache-ttl <秒> |
索引缓存时长（llms.json） |
300 |
也支持同名环境变量：MOFOX_DOCS_BASE_URL、MOFOX_DOCS_TIMEOUT、MOFOX_DOCS_CACHE_TTL。
开发
uv sync # 创建虚拟环境并安装依赖
uv run mofox-docs-mcp # 运行服务器
uv build # 构建 sdist / wheel 到 dist/
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for mofox-docs-mcp 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mofox_docs_mcp-0.1.0.tar.gz | 67.6 kB | With provenance | Details for mofox_docs_mcp-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mofox_docs_mcp-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for mofox_docs_mcp-0.1.0-py3-none-any.whl |
Total release size: 75.9 kB
Release files / mofox_docs_mcp-0.1.0.tar.gz
| Download URL | mofox_docs_mcp-0.1.0.tar.gz |
|---|---|
| Size | 67.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
00850668c008fcf4b66d7e2784523e7f454a0457613f268efcdc86399a0df442
|
|
BLAKE2b-256 checksum How to use checksums |
b395f852f5dd5b962bef74b6a973005257a23c794ddcd0c73f0672d48cf85c49
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logRelease files / mofox_docs_mcp-0.1.0-py3-none-any.whl
| Download URL | mofox_docs_mcp-0.1.0-py3-none-any.whl |
|---|---|
| Size | 8.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c9fc2d35bf820505f4d78c870059e1e759da3cc776cfbca34f7636d8886e14e8
|
|
BLAKE2b-256 checksum How to use checksums |
815afd87815225c706e9f1aa35ede0424dee28685143158d360aa12216b190aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logSecurity for mofox-docs-mcp 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for mofox_docs_mcp-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
