汉佐 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())

功能概述

基本操作

1. 文件索引

将指定目录下的文件进行语义索引：

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

2. 语义搜索

通过自然语言查询代码库：

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