文档 MCP
文档 MCP 让 Claude Code、Codex、Cursor 等 AI 客户端直接检索本站文档。你用自然语言提问,客户端调用 search_cloud 工具取回相关的文档原文片段,再结合这些片段回答你。
# 1. 实际使用效果
下面是 Claude Code 实际使用文档 MCP 的对话截图。以 Cloud 文档为例,询问“微服务网关如何校验用户 Token,并把用户信息传给下游服务?”,客户端调用 search_cloud 检索文档,再根据返回的原文说明认证流程和相关类。

# 2. 获取个人配置
文档 MCP 仅对星球 VIP 用户开放。选择你使用的客户端,再点击按钮,校验通过后会生成带有你个人签名的配置。
签名有效期
- 签名最长有效 7 天,星球会员到期后也会失效。在本站重新登录生成新签名后,旧签名立即失效。
- 签名失效后,请重新登录,回到本页重新获取,替换客户端里的旧配置,再重新连接或重启客户端。
- 配置里含有你的个人签名,请勿分享,也不要提交到代码仓库。
# 3. 配置客户端
下文示例中的 YOUR_SIGNATURE 是占位符。第 2 节生成的配置已经填好签名,可以直接使用。
# 3.1 Claude Code
在终端执行(参见 Claude Code 官方文档 (opens new window)):
claude mcp add --transport http yudao-cloud-doc https://svip.iocoder.cn/mcp --header "Authorization: Bearer YOUR_SIGNATURE"
添加后,在 Claude Code 中执行 /mcp 可以查看连接状态。签名更新后,先执行 claude mcp remove yudao-cloud-doc,再用新配置重新添加。
# 3.2 Codex
在 ~/.codex/config.toml 末尾追加以下内容(参见 Codex 官方文档 (opens new window)):
[mcp_servers.yudao-cloud-doc]
url = "https://svip.iocoder.cn/mcp"
http_headers = { Authorization = "Bearer YOUR_SIGNATURE" }
文件里已有 [mcp_servers.yudao-cloud-doc] 段落时,只替换这一段,不要改动其他内容。
# 3.3 Cursor
在 ~/.cursor/mcp.json 的 mcpServers 中加入以下服务器(参见 Cursor 官方文档 (opens new window)):
{
"mcpServers": {
"yudao-cloud-doc": {
"url": "https://svip.iocoder.cn/mcp",
"headers": {
"Authorization": "Bearer YOUR_SIGNATURE"
}
}
}
}
文件里已有其他服务器时,只把 yudao-cloud-doc 这一项合并进去,保留其他服务器。
# 3.4 其他客户端
客户端需要支持远程 Streamable HTTP 和自定义请求头。请按客户端官方文档填写以下信息:
| 项目 | 值 |
|---|---|
| 地址 | https://svip.iocoder.cn/mcp |
| 传输方式 | Streamable HTTP |
| 请求头 | Authorization: Bearer YOUR_SIGNATURE |
# 4. 使用示例
配置完成后,直接用自然语言提问,例如:
查一下芋道文档,数据权限怎么配置?
客户端会自动调用 search_cloud,参数示例如下:
{
"query": "数据权限怎么配置",
"topK": 10
}
query 是检索内容。topK 可选,表示最多返回几条片段,取值 1 ~ 10,默认 10,实际返回可能更少。服务端只返回文档原文片段,答案由你的 AI 客户端生成。
如果你在 ruoyi-vue-pro 文档 (opens new window) 也登录过,客户端可能同时获得 search_doc,并按问题自动选择,不需要手动切换。
# 5. 常见问题
# 5.1 客户端提示 401
签名无效、已过期,或已被新的登录替换。请重新登录,回到本页重新获取配置,替换客户端里的旧配置,再重新连接或重启客户端。
# 5.2 客户端提示 403
账号没有本站文档的检索权限,例如只在 ruoyi-vue-pro 文档登录过。请在本站重新登录后重新获取配置。
# 5.3 页面提示连接失败
页面暂时连不上会员服务,不代表你的会员资格有问题。请检查网络、代理或浏览器扩展,确认可以访问 svip.iocoder.cn 后重试。