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",

✨ 主要特性

基本操作

• 文件索引：可将指定目录下的文件进行语义索引，支持递归索引和指定文件类型。
• 语义搜索：能够通过自然语言查询代码库，方便开发者快速定位所需代码。