Sourcesage

🚀 SourceSage：大語言模型（LLM）的高效代碼內存

SourceSage 是一個基於模型上下文協議（MCP）的服務器，旨在助力大語言模型（LLM）高效理解和記憶代碼庫中的關鍵信息。它支持多種編程語言，專注於存儲和檢索代碼語義、實體及其關係，為代碼分析和管理提供了強大的支持。

🚀 快速開始

安裝方法

1. 克隆倉庫：

   git clone https://github.com/your-repository.git
   cd source-sage
   

2. 運行服務器：

   python3 -m sourcesage.server
   

使用說明

1. 分析代碼：通過 LLM 分析你的代碼文件。

   "請分析這個 Python 文件，並註冊其中的關鍵實體和關係。"
   

2. 註冊實體：LLM 會使用 register_entity 工具來存儲代碼中的實體。

   "我會註冊這個文件中的主類。"
   

3. 查詢知識：後續可以通過以下方式查詢代碼庫：

   • 獲取定義在代碼庫中的類列表：

     "請告訴我我的代碼庫中有哪些類？"
     

   • 查看特定類的詳細信息：

     "請顯示 `User` 類的詳細信息。"
     

4. 獲取編碼模式：可以查詢代碼中使用的模式和約定。

   "請告訴我我的代碼庫中使用了哪些設計模式？"
   

✨ 主要特性

1. 利用 LLM 的理解能力：SourceSage 利用 LLM 對代碼語義的理解，能夠處理多種編程語言。
2. 存儲語義知識：與傳統的代碼分析工具不同，SourceSage 專注於存儲代碼的語義和實體之間的關係。
3. 語言中立：支持任何 LLM 能夠理解的編程語言。
4. 優化存儲效率：採用高效的存儲機制，最小化 token 使用量。
5. 隨 LLM 技術進步而發展：隨著 LLM 的能力提升，SourceSage 也能相應改進代碼理解和分析。

💻 使用示例

基礎用法

"請分析這個 Python 文件，並註冊其中的關鍵實體和關係。"

高級用法

"我會記錄這些類之間的繼承關係。"

📚 詳細文檔

核心功能模塊

1. 註冊實體：

   • register_entity：用於存儲代碼中的關鍵實體（如類、函數等）。
   • register_relationship：用於記錄實體之間的關係（如繼承、依賴等）。

2. 查詢知識：

   • query_entities：根據語言、名稱模式或其他條件查詢實體。
   • get_entity_details：獲取特定實體的詳細信息。
   • query_patterns：按編程語言或模式名稱查詢代碼模式。
   • query_style_conventions：按編程語言或約定名稱查詢編碼風格。

3. 統計與清理：

   • get_knowledge_statistics：獲取知識圖譜的統計數據。
   • clear_knowledge：清空所有存儲的知識。

示例工作流

1. 分析代碼：

   "請分析這個 Python 文件，並註冊其中的關鍵實體和關係。"
   

2. 註冊實體：

   "我會註冊這個文件中的主類。"
   

3. 註冊關係：

   "我會記錄這些類之間的繼承關係。"
   

4. 查詢知識：
   • 獲取類列表：

     "請告訴我我的代碼庫中有哪些類？"
     

   • 查看特定類的詳細信息：

     "請顯示 `User` 類的詳細信息。"
     

📄 許可證

本項目採用 MIT License 許可證，具體詳情請參閱 LICENSE 文件。

🌟 項目貢獻

歡迎社區貢獻！如果你有任何問題或建議，請隨時提交 Pull Request。