<h1 style="font-weight:normal"> <a href="https://ragrabbit.com"> <img src="./apps/saas/public/logo.svg" alt="RagRabbit" width=35> </a>  RagRabbit  <a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmadarco%2Fragrabbit&env=OPENAI_API_KEY,AUTH_USERNAME,AUTH_PASSWORD,AUTH_SECRET&envDescription=Get%20an%20OpenAI%20Api%20Key%20and%20set%20AUTH_USERNAME%20and%20AUTH_PASSWORD%20to%20the%20desired%20credentials%20to%20secure%20the%20admin%20section.%20Also%20be%20sure%20to%20enable%20the%20Postgres%20database%20integration&envLink=https%3A%2F%2Fplatform.openai.com%2Fapi-keys&demo-title=RagRabbit%20-%20AI%20Site%20Search%20and%20LLM.txt&demo-description=Site%20AI%20Search%20and%20LLM.txt%20in%20Minutes%2C%20Open%20Source%20with%201%20Click%20Deploy%20on%20Vercel.&demo-url=https%3A%2F%2Fragrabbit.vercel.app%2F&demo-image=https%3A%2F%2Fragrabbit.vercel.app%2Fopengraph-image.png&stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D&root-directory=apps/saas"><img src="https://img.shields.io/badge/deploy%20on-vercel-black.svg"></a> <a href="https://github.com/madarco/ragrabbit/blob/master/license.md"><img src=https://img.shields.io/github/license/madarco/ragrabbit.svg?colorB=ff0000></a> <a href="https://www.npmjs.com/package/@ragrabbit/mcp"><img src="https://img.shields.io/npm/d18m/%40ragrabbit%2Fmcp?label=npm" /></a> <img src="https://img.shields.io/github/stars/madarco/ragrabbit" /> </h1>

自托管站点 AI 搜索，LLMs.txt，MCP 服务器，可抓取您的内容。在 Vercel 上一键部署。 <br>

<p align="center">

</p>

工作原理

RagRabbit 是一个 Next.js Turborepo 应用程序，它使用 Llamaindex 和 pgVector。

特性

• 💬 聊天小部件：可嵌入的 AI 聊天代理和即时搜索
• 🕸️ 网站爬虫：使用 pgVector 和 PostgreSQL 抓取和索引页面
• 📄 LLMs.txt 生成：完全可自定义，带有 ToC 重新排序
• 🔌 MCP 服务器：npx @ragrabbit/mcp 从 Claude Desktop 和 Cursor IDE 访问您的文档
• 🛠️ 灵活：身份验证、开源、API 密钥访问
• 🚀 轻松部署：在 Vercel 上一键设置

集成：

• Fumadocs

演示

查看 RagRabbit 演示页面

安装

要在 Vercel 上安装：

要求：

• Node.js 20.x
• 带有 pgVector 的 PostgreSQL
• OpenAI API 密钥
• （可选）Trigger.dev API 密钥

配置

设置以下环境变量：

• OPENAI_API_KEY

对于用户名/密码登录：

• ADMIN_USER
• ADMIN_PASSWORD

对于电子邮件登录：

• RESEND_AUTH=true
• 要限制对这些电子邮件的访问：RESEND_ALLOWED_EMAILS="test@test.com,foo@bar.com"
• 要不发送电子邮件，而是记录登录链接（在 Vercel 日志中）：SIMULATE_EMAILS=true

有关完整列表，请参见 .env.example。

如何使用

使用索引部分添加要索引的新 url/网站，可以是单个 url 或要递归抓取的网站：

然后启动 Job Runner（保持选项卡打开直到完成）

在 LLM.txt 部分，您可以预览生成的 LLM.txt 文件：

然后，您可以使用以下代码段将小部件嵌入到您的网站中：

聊天按钮

在页面底部嵌入一个按钮：

<script src="https://<your deployed app>/widget.js"></script>

聊天小部件

在页面中的任意位置插入搜索输入：

<script src="https://ragrabbit.com/widget.js?type=search"></script>
<ragrabbit-search></ragrabbit-search>

与 React.js 一起使用

"use client";

import Script from "next/script";

export function RagRabbitSearch() {
  return (
    <>
      <Script src="/widget.js?type=search" strategy="lazyOnload" />
      <style>{`
        ragrabbit-search .ragrabbit-search-input {
            padding: 6px 12px;
        }
      `}</style>
      <div className="ml-auto min-w-[300px] flex-1 sm:flex-initial">
        {/* @ts-ignore - Custom element will be mounted by external script */}
        <ragrabbit-search></ragrabbit-search>
      </div>
    </>
  );
}

MPC 服务器

MCP 服务器允许任何受支持的 AI 客户端使用语义搜索从您的文档中检索页面。

Claude Desktop

添加一个自定义 mcp 服务器，其中包含您的产品名称，以便 Claude AI 在查找有关它的信息时可以使用它。

在 claude_desktop_config.json 中（Claude -> 设置 -> 开发者 -> 编辑配置）

{
  "mcpServers": {
    "<name_of_your_documentation_no_spaces>": {
      "command": "npx",
      "args": ["@ragrabbit/mcp", "http://<RagRabbit install>/", "<name of your documentation>"]
    }
  }
}

在 Cursor IDE 中

转到 Cursor -> 设置 -> Cursor 设置 -> 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 知道在查找信息时使用它

配置选项

聊天按钮

您可以通过将以下参数添加到 widget.js 脚本标记来配置聊天按钮：

buttonText

<script src="https://ragrabbit.com/widget.js?buttonText=Ask%20AI"></script>

搜索小部件

您可以通过添加以下参数并使用 mountSearch 调用来配置搜索小部件：

searchPlaceholder

<div id="search-container"></div>
<script>
  window.mountSearch("search-container", { searchPlaceholder: "Search documentation..." });
</script>

集成

Fumadocs

创建一个组件来替换搜索对话框：

pnpm add @ragrabbit/search-react

"use client";
import type { SharedProps } from "fumadocs-ui/components/dialog/search";
import { RagRabbitModal } from "@ragrabbit/search-react";

export default function SearchDialog({ open, onOpenChange }: SharedProps) {
  return <RagRabbitModal
    domain="http://localhost:3000/"
    open={open}
    onOpenChange={onOpenChange}
    />;
}

然后在 layout.tsx 中设置它：

<RootProvider
  search={{
    SearchDialog,
  }}
>
  ...
</RootProvider>

（可选）添加浮动聊天按钮：

"use client";
import { RagRabbitChatButton } from "@ragrabbit/search-react";

export default function ChatButton() {
  return <RagRabbitChatButton domain="http://localhost:3000/" />;
}

并将其添加到 layout.tsx：

<body className="flex flex-col min-h-screen">
  <ChatButton />
  ...

开发

# 启动数据库（需要 Docker）
pnpm dev:utils # 启动带有 pgvector 的 postgresql、Storybook 和 Drizzle ORM Studio

# 启动应用程序
cd apps/saas
pnpm dev

目录结构：

RagRabbit 是一个带有 Turborepo 的 monorepo，一个 Next.js 应用程序和一个具有独立包的模块化设计。

apps/
├── docs -> 文档站点
├── saas -> 主应用程序
└── web -> 网站
packages/
├── db -> 带有 Drizzle ORM 的数据库
├── auth -> 带有 Auth.js 的身份验证
├── core -> 共享实用程序
├── design -> 设计系统
├── rag -> 带有 LlamaIndexTS 的 LLM 和 RAG 包
├── jobs -> 带有 Trigger.dev 的作业运行器
└── storybook -> 一个 Next.js Storybook 应用程序
.cursorrules -> 使用所有位置微调的 Cursor 规则，以使用 monorepo

作者

Marco D'Alia - @madarco - Linkedin

许可证

MIT