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
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 mofox_docs_mcp-0.1.0.tar.gz.
File metadata
- Download URL: mofox_docs_mcp-0.1.0.tar.gz
- Upload date:
- Size: 67.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
00850668c008fcf4b66d7e2784523e7f454a0457613f268efcdc86399a0df442
|
|
| MD5 |
6ae5b26b1867052acc03b3dae9d8ad2f
|
|
| BLAKE2b-256 |
b395f852f5dd5b962bef74b6a973005257a23c794ddcd0c73f0672d48cf85c49
|
Provenance
The following attestation bundles were made for mofox_docs_mcp-0.1.0.tar.gz:
Publisher:
publish.yml on minecraft1024a/mofox-docs-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mofox_docs_mcp-0.1.0.tar.gz -
Subject digest:
00850668c008fcf4b66d7e2784523e7f454a0457613f268efcdc86399a0df442 - Sigstore transparency entry: 2617568220
- Sigstore integration time:
-
Permalink:
minecraft1024a/mofox-docs-mcp@6f988cd46bfff75da411094c1f5406b0216d8497 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/minecraft1024a
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6f988cd46bfff75da411094c1f5406b0216d8497 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mofox_docs_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mofox_docs_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c9fc2d35bf820505f4d78c870059e1e759da3cc776cfbca34f7636d8886e14e8
|
|
| MD5 |
6388d337bb9e824fc871a55177caf5fa
|
|
| BLAKE2b-256 |
815afd87815225c706e9f1aa35ede0424dee28685143158d360aa12216b190aa
|
Provenance
The following attestation bundles were made for mofox_docs_mcp-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on minecraft1024a/mofox-docs-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mofox_docs_mcp-0.1.0-py3-none-any.whl -
Subject digest:
c9fc2d35bf820505f4d78c870059e1e759da3cc776cfbca34f7636d8886e14e8 - Sigstore transparency entry: 2617568231
- Sigstore integration time:
-
Permalink:
minecraft1024a/mofox-docs-mcp@6f988cd46bfff75da411094c1f5406b0216d8497 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/minecraft1024a
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6f988cd46bfff75da411094c1f5406b0216d8497 -
Trigger Event:
push
-
Statement type:
