Skip to main content

Yellhorn MCP server uses Gemini 2.5 pro to generate detailed workplans and review pull requests.

Project description

Yellhorn MCP

Yellhorn Logo

A Model Context Protocol (MCP) server that exposes Gemini 2.5 Pro capabilities to Claude Code for software development tasks.

Features

  • Generate workplans: Creates GitHub issues with detailed implementation plans based on your codebase, with customizable title and detailed description
  • Isolated Development Environments: Automatically creates Git worktrees and linked branches for streamlined, isolated development workflow
  • Review Code Diffs: Evaluates pull requests against the original workplan with full codebase context and provides detailed feedback
  • Seamless GitHub Integration: Automatically creates labeled issues with proper branch linking in the GitHub UI, posts reviews as PR comments with references to original issues, and handles asynchronous processing
  • Context Control: Use .yellhornignore files to exclude specific files and directories from the AI context, similar to .gitignore
  • MCP Resources: Exposes workplans as standard MCP resources for easy listing and retrieval

Installation

# Install from PyPI
pip install yellhorn-mcp

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

Configuration

The server requires the following environment variables:

  • GEMINI_API_KEY: Your Gemini API key (required)
  • REPO_PATH: Path to your repository (defaults to current directory)
  • YELLHORN_MCP_MODEL: Gemini model to use (defaults to "gemini-2.5-pro-exp-03-25")

The server also requires the GitHub CLI (gh) to be installed and authenticated.

Usage

Running the server

# As a standalone server
yellhorn-mcp --repo-path /path/to/repo --host 127.0.0.1 --port 8000

# Using the MCP CLI
mcp dev yellhorn_mcp.server

# Install as a permanent MCP server for Claude Desktop
mcp install yellhorn_mcp.server

# Set environment variables during installation
mcp install yellhorn_mcp.server -v GEMINI_API_KEY=your_key_here -v REPO_PATH=/path/to/repo

Integration with Claude Code

When working with Claude Code, you can use the Yellhorn MCP tools by:

  1. Starting a project task:

    Please generate a workplan with title "[Your Title]" and detailed description "[Your detailed requirements]"
    
  2. Navigate to the created worktree directory:

    cd [worktree_path]  # The path is returned in the response
    
  3. View the workplan if needed:

    # Option 1: From the worktree directory (auto-detects issue number)
    # While in the worktree directory
    Please get the current workplan for this worktree
    
    # Option 2: From the main repository (requires explicit issue number)
    # You don't need to be in the worktree directory
    Please get the workplan for issue #123
    
  4. Make your changes, create a PR, and request a review:

    # First create a PR using your preferred method (Git CLI, GitHub CLI, or web UI)
    git add .
    git commit -m "Implement feature"
    git push origin HEAD
    gh pr create --title "[PR Title]" --body "[PR Description]"
    
    # Option 1: From the worktree directory (auto-detects issue number)
    # While in the worktree directory, ask Claude to review it
    Please trigger a review for PR "[PR URL]" against the original workplan
    
    # Option 2: From the main repository (requires explicit issue number)
    # You don't need to be in the worktree directory
    Please trigger a review for PR "[PR URL]" against the workplan in issue #123
    

Tools

generate_workplan

Creates a GitHub issue with a detailed workplan based on the title and detailed description. Also creates a Git worktree with a linked branch for isolated development.

Input:

  • title: Title for the GitHub issue (will be used as issue title and header)
  • detailed_description: Detailed description for the workplan

Output:

  • JSON string containing:
    • issue_url: URL to the created GitHub issue
    • worktree_path: Path to the created Git worktree directory

get_workplan

Retrieves the workplan content (GitHub issue body) associated with a workplan. Can be run from a worktree (auto-detects issue) or the main repo (requires explicit issue_number).

Input:

  • issue_number: Optional issue number for the workplan. Required if run outside a Yellhorn worktree.

Output:

  • The content of the workplan issue as a string

review_workplan

Triggers an asynchronous code review for a Pull Request against its original workplan issue. Can be run from a worktree (auto-detects issue) or the main repo (requires explicit issue_number).

Input:

  • pr_url: The URL of the GitHub Pull Request to review
  • issue_number: Optional issue number for the workplan. Required if run outside a Yellhorn worktree.

Output:

  • A confirmation message that the review task has been initiated

Resource Access

Yellhorn MCP also implements the standard MCP resource API to provide access to workplans:

  • list-resources: Lists all workplans (GitHub issues with the yellhorn-mcp label)
  • get-resource: Retrieves the content of a specific workplan by issue number

These can be accessed via the standard MCP CLI commands:

# List all workplans
mcp list-resources yellhorn-mcp

# Get a specific workplan by issue number
mcp get-resource yellhorn-mcp 123

Development

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

CI/CD

The project uses GitHub Actions for continuous integration and deployment:

  • Testing: Runs automatically on pull requests and pushes to the main branch

    • Linting with flake8
    • Format checking with black
    • Testing with pytest
  • Publishing: Automatically publishes to PyPI when a version tag is pushed

    • Tag must match the version in pyproject.toml (e.g., v0.2.2)
    • Requires a PyPI API token stored as a GitHub repository secret (PYPI_API_TOKEN)

To release a new version:

  1. Update version in pyproject.toml
  2. Commit changes: git commit -am "Bump version to X.Y.Z"
  3. Tag the commit: git tag vX.Y.Z
  4. Push changes and tag: git push && git push --tags

For more detailed instructions, see the Usage Guide.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yellhorn_mcp-0.2.2.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yellhorn_mcp-0.2.2-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file yellhorn_mcp-0.2.2.tar.gz.

File metadata

  • Download URL: yellhorn_mcp-0.2.2.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for yellhorn_mcp-0.2.2.tar.gz
Algorithm Hash digest
SHA256 a37a683a9f80875cf807220a6822b4c60a08b40940d0551214225f00f3624bab
MD5 e3f9f18f9316e93e227a9f520b81528a
BLAKE2b-256 a5286a8fc7b178193308bc725d8ce564d24db4cdc7eb7aef7deec3db5114e67e

See more details on using hashes here.

File details

Details for the file yellhorn_mcp-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: yellhorn_mcp-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for yellhorn_mcp-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 057f4d7d13909122f0465b44ca1edc001518bb0dbd4cfd48e2ef3f76a06f9b60
MD5 7957b3829df06877d013974d2ddce929
BLAKE2b-256 d8b192b6efc058071b2575fb8afa27399f9edc45435e9ee99397129c4f0fa77f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page