使用说明

项目简介

RagRabbit 是一个开源项目，旨在帮助用户轻松构建AI站点搜索和LLM.txt服务。除了提供站点爬取、内容索引和AI搜索等功能外，RagRabbit 还实现了一个 MCP (Model Context Protocol) 服务器。该 MCP 服务器允许支持 MCP 协议的 LLM 客户端（如 Claude Desktop 和 Cursor 编辑器）访问 RagRabbit 索引的文档，从而为 LLM 提供上下文信息，提升其在特定领域知识方面的能力。

主要功能点

MCP 服务器功能:
- 资源 (Resources) 托管: 通过 MCP 服务器暴露 LLMs.txt 文档，方便 LLM 客户端获取关于模型的信息。
- 工具 (Tools) 注册与执行: 注册 'search_docs' 工具，允许 LLM 客户端调用 RagRabbit 的语义搜索功能，检索相关文档内容。
- JSON-RPC 协议通信: 使用标准的 JSON-RPC 协议与 MCP 客户端进行通信。
- Stdio 传输协议: 支持 Stdio 传输协议，方便本地或命令行环境下的集成。
RagRabbit 核心功能 (非MCP服务器直接功能，但为MCP服务器提供数据支持):
- 网站爬取与Markdown转换
- 基于 pgVector 的向量嵌入和语义搜索
- 可嵌入的聊天 Widget 和 LLM.txt 文件生成

安装步骤

由于 RagRabbit 项目本身是一个完整的 Web 应用，要使用其 MCP 服务器功能，您需要先部署 RagRabbit 应用。以下是简要的安装步骤 (更详细的步骤请参考仓库 README):

环境准备:
- Node.js 20.x
- PostgreSQL 数据库 (需启用 pgVector 扩展)
- OpenAI API Key (用于内容向量化和LLM功能)
一键部署到 Vercel:
- 点击仓库 README 中的 "Deploy with Vercel" 按钮，按照 Vercel 的指引完成部署。
- 在 Vercel 部署过程中，您需要配置以下环境变量：
  - 'OPENAI_API_KEY': 您的 OpenAI API 密钥。
  - 'AUTH_USERNAME' 和 'AUTH_PASSWORD' (可选): 设置后台管理界面的用户名和密码。
配置数据库:
- 确保 Vercel 项目已集成 PostgreSQL 数据库，并配置好 pgVector 扩展。
访问 RagRabbit 应用:
- 部署完成后，访问 Vercel 提供的应用域名，即可使用 RagRabbit 的 Web 界面。

服务器配置 (MCP 客户端配置)

要让 MCP 客户端（如 Claude Desktop 或 Cursor）连接到 RagRabbit 的 MCP 服务器，您需要在客户端中配置服务器启动命令和参数。

重要提示: 以下配置信息为 JSON 格式，请直接复制到 MCP 客户端的配置文件中，无需进行代码修改。

Claude Desktop 配置 (编辑 'claude_desktop_config.json')

{
  "mcpServers": {
    "<您的文档名称，请勿包含空格>": {
      "command": "npx",
      "args": ["@ragrabbit/mcp", "http://<您的RagRabbit应用域名>/", "<您的文档名称>"]
    }
  }
}

参数说明:

'"command": "npx"': MCP 服务器的启动命令，通常使用 'npx' 运行 '@ragrabbit/mcp' 包。
'"args"': 传递给 '@ragrabbit/mcp' 命令的参数数组。
- '"@ragrabbit/mcp"': MCP 服务器的 npm 包名。
- '"http://<您的RagRabbit应用域名>/"': 请替换为您的 RagRabbit 应用的实际域名 (例如: 'https://your-ragrabbit-app.vercel.app/')。这是 RagRabbit 应用的根 URL，MCP 服务器将基于此 URL 提供服务。
- '"<您的文档名称>"': 请替换为您文档的自定义名称 (例如: 'MyCompany Docs')。这个名称将显示在 Claude 等客户端中，用于标识您的文档搜索服务。

Cursor 编辑器配置 (Cursor Settings -> MCP)

在 Cursor 中添加新的 MCP 服务器，类型选择 "command"，并配置以下信息：

Command: 'npx @ragrabbit/mcp'
Arguments: '"http://<您的RagRabbit应用域名>/" "<您的文档名称>"'