Self Hosted Site AI Search, LLMs.txt, MCP Server that crawls your content. 1-Click Deploy on Vercel.
<br>
RagRabbit
How it works
Features
- Chat Widget: Embeddable AI Chat agent and instant Search
- Website Crawler: scrapes and index pages with pgVector and PostgreSQL
- LLMs.txt Generation: fully customizable wiht ToC reorder
- MCP Server:
npx @ragrabbit/mcpto access your docs from Claude Desktop and Cursor IDE
- Flexible: Authentication, Open Source, API Keys access
- Easy Deployment: One-click setup on Vercel
Integrations:
- Fumadocs
Demo
View RagRabbit Demo Page
RagRabbit Demo
Install
To install on Vercel:
Requirements:
- Node.js 20.x
- PostgreSQL w/ pgVector
- OpenAI API Key
- (Optional) Trigger.dev API Key
Configuration
Set the following environment variables:
- OPENAI_API_KEY
For username/password login:
- ADMIN_USER
- ADMIN_PASSWORD
For email login:
- RESEND_AUTH=true
- To restrict access to those emails: RESEND_ALLOWED_EMAILS="test@test.comfoo@bar.com"
- To not send emails but logs the login link instead (in Vercel logs): SIMULATE_EMAILS=true
See .env.example for the complete list.
How to use
Use the Indexing section to add a new url/website to index, either a single url or a website to crawl recursively:
RagRabbit Indexing
RagRabbit Crawl Modal
Then start the Job Runner (keep the tab open until it finish)
RagRabbit Job Runner
In the LLM.txt section you can preview the generated LLM.txt file:
RagRabbit LLM.txt
You can then embed the widget in your site with the following snippet:
Chat Button
Embed a button at the bottom of your page:
RagRabbit Embed Widget Button
Chat Widget
Insert a search input anwhere in your page:
RagRabbit Widget
To use with React.js
MPC Server
The MCP Server allows any supported AI Clients to retrieve pages from your documentation using semantic search.
Claude Desktop
Add a custom mcp server with the name of your product, so that Claude AI can use it when looking for info about it.
in
claude_desktop_config.json (Claude -> Settings -> Developer -> Edit Config)In Cursor IDE
Go to Cursor -> Settings -> Cursor Settings -> MCP
And add a new MCP of type
command with the command:Arguments:
ragrabbit-url: (Required) The base URL of your RagRabbit instance, eg https://my-ragrabbit.vercel.com/
name: (Required) Custom name for the documentation search service (defaults to "RagRabbit") so that AI will know to use it when looking for info
Configuration Options
Chat button
You can configure the chat button by adding the following parameters to the widget.js script tag:
buttonText
Search widget
You can configure the search widget by adding the following parameters and use the mountSearch call:
searchPlaceholder
Integrations
Fumadocs
Create a component to replace the Search Dialog:
Then set it in the
layout.tsx:Optionally add the Floating Chat button:
And add it to the
layout.tsx:Development
Directory structure:
RagRabbit is a monorepo with Turborepo a Next.js app and a modular design with separate packages.
Author
License
MIT
Self Hosted Site AI Search, LLMs.txt, MCP Server that crawls your content. 1-Click Deploy on Vercel.
<br>
RagRabbit
How it works
Features
- Chat Widget: Embeddable AI Chat agent and instant Search
- Website Crawler: scrapes and index pages with pgVector and PostgreSQL
- LLMs.txt Generation: fully customizable wiht ToC reorder
- MCP Server:
npx @ragrabbit/mcpto access your docs from Claude Desktop and Cursor IDE
- Flexible: Authentication, Open Source, API Keys access
- Easy Deployment: One-click setup on Vercel
Integrations:
- Fumadocs
Demo
View RagRabbit Demo Page
RagRabbit Demo
Install
To install on Vercel:
Requirements:
- Node.js 20.x
- PostgreSQL w/ pgVector
- OpenAI API Key
- (Optional) Trigger.dev API Key
Configuration
Set the following environment variables:
- OPENAI_API_KEY
For username/password login:
- ADMIN_USER
- ADMIN_PASSWORD
For email login:
- RESEND_AUTH=true
- To restrict access to those emails: RESEND_ALLOWED_EMAILS="test@test.comfoo@bar.com"
- To not send emails but logs the login link instead (in Vercel logs): SIMULATE_EMAILS=true
See .env.example for the complete list.
How to use
Use the Indexing section to add a new url/website to index, either a single url or a website to crawl recursively:
RagRabbit Indexing
RagRabbit Crawl Modal
Then start the Job Runner (keep the tab open until it finish)
RagRabbit Job Runner
In the LLM.txt section you can preview the generated LLM.txt file:
RagRabbit LLM.txt
You can then embed the widget in your site with the following snippet:
Chat Button
Embed a button at the bottom of your page:
RagRabbit Embed Widget Button
Chat Widget
Insert a search input anwhere in your page:
RagRabbit Widget
To use with React.js
MPC Server
The MCP Server allows any supported AI Clients to retrieve pages from your documentation using semantic search.
Claude Desktop
Add a custom mcp server with the name of your product, so that Claude AI can use it when looking for info about it.
in
claude_desktop_config.json (Claude -> Settings -> Developer -> Edit Config)In Cursor IDE
Go to Cursor -> Settings -> Cursor Settings -> MCP
And add a new MCP of type
command with the command:Arguments:
ragrabbit-url: (Required) The base URL of your RagRabbit instance, eg https://my-ragrabbit.vercel.com/
name: (Required) Custom name for the documentation search service (defaults to "RagRabbit") so that AI will know to use it when looking for info
Configuration Options
Chat button
You can configure the chat button by adding the following parameters to the widget.js script tag:
buttonText
Search widget
You can configure the search widget by adding the following parameters and use the mountSearch call:
searchPlaceholder
Integrations
Fumadocs
Create a component to replace the Search Dialog:
Then set it in the
layout.tsx:Optionally add the Floating Chat button:
And add it to the
layout.tsx:Development
Directory structure:
RagRabbit is a monorepo with Turborepo a Next.js app and a modular design with separate packages.
Author
License
MIT