Shebe

🚀 Shebe

Shebe是一款用於代碼搜索的簡單RAG服務，它藉助快速的BM25全文搜索技術，為代碼倉庫提供支持，同時集成了適用於Claude Code的MCP工具。

🚀 快速開始

請參考 INSTALLATION.md。

✨ 主要特性

什麼是Shebe？

Shebe提供代碼的內容搜索功能，可通過關鍵詞搜索在大型代碼庫中查找函數、API和代碼模式。

主要特性如下：

• 查詢延遲低至2ms
• 索引速度達2k - 12k文件/秒（0.5秒可索引6k個文件）
• 每次查詢使用200 - 700個令牌
• 僅使用BM25算法，無需嵌入向量或GPU支持
• 全面支持UTF - 8編碼（包括表情符號、中文、日文、韓文及特殊字符）
• 為Claude Code提供14種MCP工具（參考文檔）

定位：通過內容搜索功能對結構化工具（Serena MCP）進行補充。

為何選擇Shebe？

當開發者使用AI編碼助手在大型代碼庫（6k + 文件）中重構符號時，通常面臨著精度（基於LSP的工具）和效率（grep/ripgrep）之間的兩難選擇。Shebe試圖消除這種權衡。

基準測試：在Istio（約6k個文件）中重構AuthorizationPolicy

Shebe通過單次調用返回帶有置信度評分和模式分類的結果，實現了端到端時間快6 - 10倍，令牌使用量減少3 - 4倍。

詳細的基準測試和工具比較請參考 WHY_SHEBE.md。

快速對比

📦 安裝指南

請參考 INSTALLATION.md 進行安裝和設置。

💻 使用示例

常見任務

以下是完成特定目標的快速鏈接：

工具選擇指南

內容搜索（使用Shebe）

適用於通過關鍵詞、模式和文本內容查找代碼：

• "查找authenticate的所有使用位置"
• "查找限流的實現位置"
• "展示錯誤處理模式"
• "查找數據庫連接配置"

結構化導航（使用Serena/LSP）

適用於精確的符號操作和類型信息查找：

• "轉到UserService的定義位置"
• "查找Handler特徵的所有實現"
• "在代碼庫中重命名oldFunc為newFunc"
• "展示此類的類型層次結構"

簡單模式匹配（使用grep/ripgrep）

適用於在小型代碼庫中進行精確字符串匹配：

• "查找精確字符串TODO:"
• "統計deprecated的出現次數"
• "在少於1000個文件中進行一次性快速搜索"

外部信息搜索（使用網絡搜索）

適用於查找文檔和社區知識：

• "最新的React 19遷移指南"
• "特定錯誤的社區解決方案"
• "關於架構模式的博客文章"

Shebe + Serena 結合使用

可在不浪費令牌的情況下全面探索代碼庫：

1. Shebe: "查找authenticate的使用位置" -> 發現文件（2ms，300個令牌）
2. Serena: "轉到定義位置" -> 導航到實現（精確）
3. Shebe: "查找相似模式" -> 發現相關代碼（2ms，300個令牌）

📚 詳細文檔

入門指南

• INSTALLATION.md - 安裝和設置指南
• 快速入門指南 - 為Claude Code提供5分鐘設置指南

參考文檔

• MCP工具參考文檔 - 14種工具的完整API文檔
• CONFIGURATION.md - 所有配置選項
• 性能基準測試 - 詳細的性能數據

開發文檔

• ARCHITECTURE.md - 開發者指南（代碼修改位置和方法）
• CONTRIBUTING.md - 貢獻指南
• CODE_OF_CONDUCT.md - 社區準則
• SECURITY.md - 安全策略和報告

🔧 技術細節

性能

在Istio（5,605個文件，以Go語言為主）和OpenEMR（6,364個文件，多語言PHP）上驗證：

詳細的基準測試請參考 docs/Performance.md。

架構

僅支持MCP的設計

Shebe僅通過MCP協議訪問，專為Claude Code集成而設計，無需HTTP服務器。

系統設計

                    +------------------+
                    |   Claude Code    |
                    +--------+---------+
                             | MCP (stdio)
                    +--------v---------+
                    |   shebe-mcp      |
                    |   (14 tools)     |
                    +--------+---------+
                             |
                    +--------v---------+
                    |  Shared Storage  |
                    | ~/.local/state/  |
                    |  shebe/sessions/ |
                    +------------------+

開發者指南請參考 ARCHITECTURE.md。

故障排除

詳細的故障排除請參考 docs/guides/mcp-setup-guide.md。

📄 許可證

請參考 LICENSE。

🤝 貢獻

我們歡迎貢獻！詳細的貢獻指南請參考 CONTRIBUTING.md。

快速檢查清單：

1. 閱讀 ARCHITECTURE.md 瞭解代碼庫指南
2. 所有397個測試必須通過（make test）
3. 無clippy警告（make clippy）
4. 每行最大長度為120個字符
5. 保持測試覆蓋率超過85%（當前為86.76%）
6. 每個功能分支提交一次

社區準則請參考 CODE_OF_CONDUCT.md。