使用说明
🤖 RageBot MCP
智能项目上下文引擎，完全支持MCP服务器。 索引你的代码库，用自然语言查询它，并将其作为工具暴露给任何人工智能客户端。
📦 安装
要将RageBot作为软件包安装，请运行：
pip install ragebot
✨ 特性
- 🔍 语义代码搜索：由FAISS和句子转换器提供支持，用于深入理解代码库。
- 💬 交互式人工智能聊天：具有上下文保留功能的多回合持久会话。
- 🤖 多提供商LLM：支持谷歌Gemini、Groq和当地Olama车型。
- 🔌 完整MCP服务器：将您的代码库作为工具公开给Claude Desktop、Cursor、Zed等。
- 📖 代码智能：自动生成文档、单元测试和符号解释。
- 📸 快照管理：立即保存、列出和恢复项目索引状态。
- 🔒 安全密钥存储：API密钥存储在操作系统密钥环（macOS密钥链、Windows凭据管理器）中。
- 🎨 现代CLI：具有交互式菜单和进度指示器的丰富终端输出。
🚀 快速开始
1.身份验证
配置您首选的AI提供商：
# Interactive setup for Gemini, Groq, or Ollama
rage auth
2.初始化和索引
准备您的项目进行分析：
cd /path/to/your/project
rage init
rage save
3.开始查询
提问或输入交互式REPL：
# Ask a quick question
rage ask "How does the authentication logic work?"
# Start interactive REPL
ragebot
📋 命令参考
核心命令
| 命令 | 描述 |
|---|---|
rage init |
在当前目录中初始化RageBot。 |
rage save |
为项目建立索引并保存快照。 |
rage ask |
问一个关于代码库的一次性问题。 |
rage chat |
启动交互式多回合聊天会话。 |
rage search |
跨文件执行语义搜索。 |
rage explain |
获取文件或符号的详细说明。 |
rage docs |
为文件生成Markdown文档。 |
rage test |
为文件生成pytest测试用例。 |
rage status |
显示项目索引和LLM连接状态。 |
rage context |
显示项目概述（使用 --tree 文件结构）。 |
管理命令
| 命令 | 描述 |
|---|---|
rage auth |
管理API密钥和活动提供程序。 |
rage config |
查看或编辑配置设置。 |
rage model |
在活动提供程序的可用型号之间切换。 |
rage snapshot |
列出、还原或删除项目快照。 |
rage history |
列出并恢复以前的聊天会话。 |
🔌 MCP服务器
RageBot是合规的 模型上下文协议 服务器。您可以将其用作AI IDE和客户端的工具集。
提供的工具：
ragebot_ask：附有引文的人工智能问答。ragebot_search：语义/关键字搜索。ragebot_save：对项目进行索引或重新索引。ragebot_explain：解释文件或符号。ragebot_file_tree：获取项目结构。ragebot_generate_docs：自动生成文档。ragebot_generate_tests：自动生成测试。ragebot_apply_edit：将自然语言编辑应用于文件。
启动服务器：
# Stdio transport (default)
ragebot-mcp-server --project /path/to/your/project
# SSE transport
ragebot-mcp-server --transport sse --port 8765 --project /path/to/your/project
📁 项目结构
ragebot/
├── agents/ # Context builders for specific AI roles
├── auth/ # Secure provider authentication (Keyring)
├── core/ # Orchestrator, Scanner, and Config management
├── llm/ # LLM implementations (Gemini, Groq, Ollama)
├── mcp/ # MCP Server implementation (Stdio & SSE)
├── parsers/ # AST-based code and document parsers
├── search/ # Vector embeddings and FAISS retrieval
├── storage/ # SQLite database and Snapshot logic
└── utils/ # UI helpers, logging, and token utilities
🛠️ 发展
如果你想贡献或从源代码运行：
-
克隆存储库：
git clone https://github.com/atharvrahate296/Ragebot-MCP cd Ragebot-MCP -
在可编辑模式下安装：
pip install -r requirements.txt -
运行测试：
python ./tests/tests.py
Contributions from all collaborators are welcome for the continued development of RageBot MCP.
📄 许可证
麻省 理工© Atharv 钱