关于 @ragrabbit/mcp
@ragrabbit/mcp 是 RagRabbit 文档搜索的 MCP 服务,可让 AI 模型访问已在 RagRabbit 实例中建立索引的文档。项目采用开源协议,可自托管,适合为网站提供语义搜索与 LLM 文档。
主要功能
- 01基于自然语言的语义文档搜索
- 02通过 search_docs 工具执行查询
- 03提供 llms.txt 形式的 LLM 文档资源
- 04支持 Claude Desktop 与 Cursor 配置
适用场景
- 01为产品文档添加 AI 可调用的搜索入口
- 02在 Cursor 中让编码助手查询项目文档
- 03在 Claude Desktop 中检索特定产品的使用说明
MCP 相关
该项目是 MCP 服务,向 MCP 客户端暴露 search_docs 工具用于文档搜索,并提供 llms.txt 资源,内容为关于 LLM 及其能力的文档。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
1收录的工具列表 · 更新于 3 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| query | string | 是 | 用于查找相关文档的搜索查询 |
详细介绍
RagRabbit 文档搜索的 MCP 服务
此服务实现了模型上下文协议(MCP),让 AI 模型能够访问使用 RagRabbit 实例索引的任意文档。
概述
MCP 服务充当 AI 客户端与 RagRabbit 托管文档之间的桥梁:
- 使用自然语言查询对文档进行语义搜索
- 访问针对大模型的文档
- 通过模型上下文协议进行标准化通信
安装
Claude Desktop
添加一个自定义 MCP 服务,并将其名称设为你的产品名称,这样 Claude AI 就能在查找相关信息时使用它。
在 claude_desktop_config.json 中(Claude -> Settings -> Developer -> Edit Config)
{
"mcpServers": {
"<name_of_your_documentation_no_spaces>": {
"command": "npx",
"args": ["@ragrabbit/mcp", "http://<RagRabbit install>/", "<name of your documentation>"]
}
}
}
在 Cursor IDE 中
前往 Cursor -> Settings -> Cursor Settings -> MCP
添加一个类型为 command 的新 MCP,并使用以下命令:
npx @ragrabbit/mcp", "http://<RagRabbit install>/", "<name of your documentation>"
参数:
ragrabbit-url:(必填)RagRabbit 实例的基础 URL,例如 https://my-ragrabbit.vercel.com/name:(必填)文档搜索服务的自定义名称(默认为 "RagRabbit"),让 AI 在查找信息时知道该使用此服务
此 MCP 暴露的工具
search_docs
对文档进行语义搜索。
参数:
query:字符串 - 用于查找相关文档的搜索查询
示例:
{
"name": "search_docs",
"arguments": {
"query": "How to implement authentication?"
}
}
可用资源
大模型文档
- URI:
llms.txt - 描述:关于大模型及其能力的文档
- MIME 类型:
text/plain
许可证
MIT
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。