使用说明

项目简介

Yellhorn MCP 是一个 Model Context Protocol (MCP) 服务器，旨在增强 Claude Code 等 LLM 在软件开发任务中的能力。它通过集成 Google Gemini 2.5 Pro 模型和 GitHub 工作流，为开发者提供代码库上下文和自动化工具，从而提升开发效率。

主要功能点

生成工作计划: 根据代码库和任务描述，自动创建包含详细实施计划的 GitHub Issues，并支持自定义标题和描述。
隔离开发环境: 自动创建 Git Worktree 和关联分支，为每个任务提供隔离的开发环境。
代码评审: 基于完整代码库上下文和原始工作计划，评估 Pull Requests 并提供详细反馈。
无缝 GitHub 集成: 自动创建带标签的 Issues，以 PR 评论形式发布评审，并处理异步任务。
上下文控制: 通过 '.yellhornignore' 文件，类似于 '.gitignore'，灵活排除特定文件和目录，控制 AI 上下文范围。

安装步骤

安装 Python 包:

pip install yellhorn-mcp

或者从源代码安装：

git clone https://github.com/msnidal/yellhorn-mcp.git
cd yellhorn-mcp
pip install -e .

安装 GitHub CLI (gh): 确保已安装 GitHub CLI 工具 ('gh') 并已完成身份验证，Yellhorn MCP 需要使用 'gh' 命令与 GitHub 仓库进行交互。

服务器配置

MCP 客户端 (如 Claude Code) 需要以下配置信息来连接 Yellhorn MCP 服务器。请将以下 JSON 配置添加到 MCP 客户端的服务器配置中。

{
  "serverName": "yellhorn-mcp",
  "command": "yellhorn-mcp",
  "args": [
    "--repo-path", "/path/to/your/repository",  // (必填) 请替换为你的本地 Git 仓库的绝对路径。
    "--model", "gemini-2.5-pro-exp-03-25"     // (可选) 指定使用的 Gemini 模型，默认为 gemini-2.5-pro-exp-03-25。
                                                // 可以根据需要修改为其他 Gemini 模型。
  ],
  "env": {
    "GEMINI_API_KEY": "YOUR_GEMINI_API_KEY"   // (必填) 请替换为你的 Google Gemini API 密钥。
                                                // 强烈建议将 API 密钥设置为环境变量，而不是硬编码在配置中。
  }
}

基本使用方法

启动 Yellhorn MCP 服务器: MCP 客户端会自动启动配置的服务器。如果需要手动启动进行测试，可以使用以下命令：

yellhorn-mcp --repo-path /path/to/your/repository --host 127.0.0.1 --port 8000

在 Claude Code 中使用: 在 Claude Code 中，你可以通过自然语言指令调用 Yellhorn MCP 提供的工具，例如：
- 'Please generate a work plan with title "[Your Title]" and detailed description "[Your detailed requirements]"' (生成工作计划)
- 'Please get the current work plan for this worktree' (获取当前 Worktree 的工作计划)
- 'Please commit my changes and create a PR with title "[PR Title]" and body "[PR Description]"' (提交工作并创建 PR) 详细的工具使用方法请参考仓库 README 或工具的描述信息。

注意: Yellhorn MCP 需要在 Git 仓库的根目录下或子目录中运行，并且需要配置正确的 Gemini API 密钥和仓库路径。

关键词

使用说明

信息