Ragrabbit

RagRabbit是一个自托管的AI站点搜索和LLM.txt生成工具，支持一键部署在Vercel上。

知识管理与记忆搜索工具 #AI搜索 #文档索引 #聊天机器人 #一键部署本地 .TypeScript

评分 : 3分

下载量 : 126

更新时间 : 2025-04-28

什么是MCP服务器？

MCP服务器是一种工具，它使您能够通过语义搜索轻松访问您的文档。这使得AI助手可以更准确地理解和回答关于您文档的问题。

如何使用MCP服务器？

要使用MCP服务器，请在您的AI客户端中添加一个自定义MCP服务器。这样，当AI需要查找有关您文档的信息时，它可以快速定位相关内容。

适用场景

MCP服务器非常适合那些希望为其文档提供强大搜索功能的企业和个人。例如，企业可以将其用于内部知识库管理，而个人则可以用它来组织自己的学习资料。

主要功能

语义搜索通过语义分析，MCP服务器能够更精准地找到与用户查询最相关的文档内容。

多语言支持MCP服务器支持多种语言，确保全球用户都能获得良好的体验。

高性能利用先进的算法和技术，MCP服务器能够在短时间内处理大量请求。

优势与局限性

优势

提升文档检索效率

增强用户体验

易于集成到现有系统中

局限性

需要一定的技术背景进行初始配置

可能对大规模数据集性能有一定影响

如何使用

安装MCP服务器

首先，确保已经安装了Node.js环境。然后运行以下命令来启动MCP服务器：npx @ragrabbit/mcp。

配置AI客户端

在您的AI客户端中添加一个新的MCP服务器条目，输入MCP服务器的URL以及文档名称。

使用案例

案例1：企业知识库管理一家公司使用MCP服务器来管理和检索其内部知识库，大大提高了员工的工作效率。

案例2：个人学习助手一位学生使用MCP服务器来组织自己的学习笔记，方便随时复习。

常见问题

如何开始使用MCP服务器？

MCP服务器支持哪些语言？

🚀 RagRabbit - 智能文档检索与生成系统

RagRabbit是一个基于大语言模型的智能文档检索与生成平台，它支持通过语义搜索快速定位文档内容，还具备上下文关联分析功能，能有效提升文档处理的效率和准确性。

🚀 快速开始

RagRabbit是一款强大的智能文档检索与生成平台，以下为你介绍如何快速上手。

✨ 主要特性

智能检索引擎：利用向量数据库实现语义相似度匹配
上下文关联分析：基于文本挖掘技术进行多轮对话支持
知识图谱构建：自动生成文档间的关联关系
可插拔AI模型：支持多种大语言模型（如LLama系列）

📦 安装指南

基本安装

安装依赖

pnpm install @ragrabbit/core @ragrabbit/ui

初始化配置文件

创建一个名为 config.json 的配置文件：

{
  "apiPort": 3000,
  "vectorDBConfig": {
    "type": "chroma",
    "host": "localhost",
    "port": 2000
  },
  "llmModel": {
    "type": "llama2"
  }
}

启动服务

pnpm run dev

配置指南

智能检索模块配置

通过 vectorDBConfig 可以指定不同的向量数据库实现：

{
  "vectorDBConfig": {
    "type": "faiss", // 支持的类型包括：chroma, faiss, milvus
    "host": "localhost",
    "port": 6345
  }
}

大语言模型配置

支持多种主流模型：

{
  "llmModel": {
    "type": "gpt-3", // 支持的类型包括：gpt-3, llama2, alpaca
    "apiEndpoint": "https://api.example.com/v1",
    "apiKey": "your-api-key"
  }
}

MPC服务器集成

搭建MPC服务器

通过 @ragrabbit/mcp 包快速搭建：

npx @ragrabbit/mcp start --port 3001

配置AI客户端

在Claude Desktop中配置：

编辑 claude_desktop_config.json 文件，添加如下内容：

{
  "mcpServers": {
    "my-documentation": {
      "command": "npx",
      "args": ["@ragrabbit/mcp", "start"]
    }
  }
}

在ChatGPT中配置：

通过环境变量设置MPC服务器地址：

export MPC_SERVER=http://localhost:3001

与Fumadocs集成

快速集成

在项目根目录下运行以下命令：

pnpm install @fumadocs/extension-rag

配置示例

添加如下配置到 config.json 文件中：

{
  "fumaIntegration": {
    "enabled": true,
    "apiKey": "your-fuma-api-key",
    "workspaceId": "your-workspace-id"
  }
}

开发指南

环境搭建

git clone https://github.com/ragrabbit-project/rag.git
cd rag
pnpm install

核心组件开发

向量数据库接口

实现自定义向量数据库：

interface VectorDB {
  init(): Promise<void>;
  addVectors(vectors: number[], metadata: object[]): Promise<string[]>;
  searchSimilar(id: string, k: number): Promise<SearchResult[]>;
}

文本处理管道

定义文本处理流程：

class TextProcessingPipeline {
  private tokenizer;
  private embeddings;

  constructor() {
    this.tokenizer = new Tokenizer();
    this.embeddings = new LlamaEmbedder();
  }

  async process(text: string): Promise<ProcessedText> {
    const tokens = this.tokenizer.tokenize(text);
    const embeds = await this.embeddings.embed(tokens);
    return { tokens, embeddings: embeds };
  }
}

贡献指南

欢迎社区贡献代码！请参考 CONTRIBUTING.md 文件了解具体流程。

💻 使用示例

基础用法

const rag = new RagManager({
  vectorDB: new ChromaDB(),
  llm: new Llama2()
});

async function search(query: string) {
  const results = await rag.search(query, { limit: 5 });
  return results.map(r => r.metadata);
}

📚 详细文档

核心功能

智能检索：通过自然语言查询快速定位文档
上下文关联：支持多轮对话和历史记录
知识图谱：自动生成文档间关系网络
插件扩展：支持多种大语言模型和存储后端

文档结构

根目录结构

project/
├── config.json          # 全局配置文件
├── package.json        # 项目依赖管理
├── src/                # 源代码目录
│   ├── core/           # 核心算法模块
│   └── ui/             # 用户界面组件
└── public/             # 静态资源目录

配置文件说明

`config.json`

{
  "mode": "development",      # 模式：开发或生产
  "vectorDBConfig": {         # 向量数据库配置
    "type": "chroma",
    "host": "localhost",
    "port": 2000
  },
  "llmModel": {               # 大语言模型配置
    "type": "gpt-3",
    "apiKey": "..."
  }
}