MCP Server 集成
MCP Server 集成
M-Doc 提供 MCP(Model Context Protocol)Server,让 AI 工具(如 Claude、Cursor 等)能够直接读取和搜索文档内容。
概述
MCP Server 通过 M-Doc 的 OpenAPI 接口,为 AI 工具提供以下能力:
| MCP 工具名 | 功能 | 说明 |
|---|---|---|
get_manifest |
获取文档目录 | 返回文档的完整目录结构(Markdown 格式) |
get_article_content |
读取文章内容 | 获取指定文章的 Markdown 原文 |
search_in_document |
语义搜索 | 在文档中搜索相关内容,返回匹配文章的标题、相关度和摘要 |
接入方式
在 Cursor / Claude Desktop / Claude Code 中配置
在 MCP 配置文件(如 .cursor/mcp.json、~/.claude.json 或 Claude Desktop 的配置)中添加:
{
"mcpServers": {
"mdoc": {
"command": "npx",
"args": ["-y", "@muleiwu/mdoc-mcp"],
"env": {
"MDOC_ACCESS_TOKEN": "mdoc_pat_xxxxx"
}
}
}
}如果使用私有部署的 M-Doc,额外添加环境变量:
"MDOC_API_BASE_URL": "https://your-mdoc-instance.com"环境变量说明
| 变量 | 必需 | 默认值 | 说明 |
|---|---|---|---|
MDOC_ACCESS_TOKEN |
是 | — | 个人访问令牌(格式:mdoc_pat_*) |
MDOC_API_BASE_URL |
否 | https://mdoc.cc |
API 基础地址(私有部署时使用) |
手动调用 API
如果不使用 MCP Server,也可以直接调用 OpenAPI 接口:
获取文档目录(Manifest)
curl -H "Authorization: Bearer mdoc_pat_xxxxx" \
"https://mdoc.cc/openapi/organizations/{orgSlug}/documents/{docSlug}/manifest?version=v1.0.0"返回 Markdown 格式的目录,包含每篇文章的 API 链接和浏览器链接。
读取文章内容
curl -H "Authorization: Bearer mdoc_pat_xxxxx" \
"https://mdoc.cc/openapi/organizations/{orgSlug}/documents/{docSlug}/articles/{articleId}/content.md"返回文章的原始 Markdown 内容。
语义搜索
curl -H "Authorization: Bearer mdoc_pat_xxxxx" \
"https://mdoc.cc/openapi/organizations/{orgSlug}/documents/{docSlug}/search?q=关键词&top_k=5"返回按相关度排序的搜索结果。
AI 阅读流程
推荐的 AI 文档阅读流程:
- 获取目录:调用
get_manifest获取文档结构 - 定位文章:根据目录找到相关文章
- 读取内容:调用
get_article_content获取全文 - 语义搜索(可选):使用
search_in_document查找特定内容
权限要求
MCP Server 使用 PAT 认证,需要以下权限:
| 功能 | 所需 Scope |
|---|---|
| 获取目录 | read:articles |
| 读取文章 | read:articles |
| 语义搜索 | read:articles |
创建 PAT 时至少选择 read:articles 权限。