Hanzo

🚀 漢佐 MCP 項目指南

漢佐 MCP 項目為開發者提供了便捷的代碼索引和語義搜索功能，通過簡單的安裝和配置，即可實現對指定目錄下文件的語義索引和自然語言查詢代碼庫。

🚀 快速開始

漢佐 MCP 項目的使用可分為安裝配置和快速上手兩部分。首先需要安裝依賴項並配置環境變量，之後便可初始化 MCP 服務，進行文件索引和語義搜索等操作。

📦 安裝指南

安裝依賴項

要使用 Hanzo MCP，請先安裝必要的 Python 包：

pip install hanzo-mcp

若需要額外功能（如向量存儲），請根據需求添加以下依賴：

• VoyageAI 支持：

pip install voyageai

• SentenceTransformer 支持：

pip install hanzo-mcp[vector,sentencetransformer]

環境變量配置

根據所選的嵌入提供商，設置相應的環境變量：

• VoyageAI：
  • 配置變量：VOYAGE_API_KEY 或 CHROMA_VOYAGE_API_KEY
• OpenAI：
  • 配置變量：OPENAI_API_KEY 或 CHROMA_OPENAI_API_KEY
• Anthropic：
  • 配置變量：ANTHROPIC_API_KEY 或 CHROMA_ANTHROPIC_API_KEY

💻 使用示例

基礎用法

初始化 MCP 服務

import asyncio
from hanzo_mcp.mcp_server import HanzoMCP

async def main():
    # 創建 Hanzo MCP 實例
    mcp = HanzoMCP(
        allowed_paths=["/path/to/project"],
        embedding_provider="voyage"  # 支持：'openai', 'anthropic', 'sentence_transformer'
    )

    # 啟動服務
    await mcp.start()

# 運行主函數
if __name__ == "__main__":
    asyncio.run(main())

高級用法

文件索引

將指定目錄下的文件進行語義索引：

result = await dev(
    ctx,
    operation="vector_index",
    path="/path/to/project",
    recursive=True,
    file_pattern="*.py"  # 可選：僅索引 Python 文件
)

語義搜索

通過自然語言查詢代碼庫：

result = await dev(
    ctx,
    operation="vector_search",

✨ 主要特性

基本操作

• 文件索引：可將指定目錄下的文件進行語義索引，支持遞歸索引和指定文件類型。
• 語義搜索：能夠通過自然語言查詢代碼庫，方便開發者快速定位所需代碼。