mofox-docs-mcp
Serves Neo-MoFox official documentation to MCP clients, enabling searching, listing, and reading docs via tools and resources.
README
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) |
快速开始
方式一:npx 直接运行(推荐)
npx -y mofox-docs-mcp
方式二:克隆 / 本地构建
npm install
npm run build
npm start
接入 Neo-MoFox
编辑 config/mcp.toml:
[mcp.stdio_servers.mofox-docs]
command = "npx"
args = ["-y", "mofox-docs-mcp"]
instructions = "提供 Neo-MoFox 官方文档的搜索与阅读功能,当用户询问框架功能、配置、插件开发、API 用法时使用"
重启 Neo-MoFox 即可生效。
其他 MCP 客户端
{
"mcpServers": {
"mofox-docs": {
"command": "npx",
"args": ["-y", "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。
开发
npm run build # 编译到 dist/
npm start # 运行
License
MIT
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
Neon Database
MCP server for interacting with Neon Management API and databases
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.
E2B
Using MCP to run code via e2b.