Skip to main content

Yellhorn offers MCP tools to generate detailed workplans with Gemini 2.5 Pro or OpenAI models and to review diffs against them using your entire codebase as context.

Project description

Yellhorn MCP

Yellhorn Logo

A Model Context Protocol (MCP) server that exposes Gemini 2.5 Pro and OpenAI capabilities to Claude Code for software development tasks using your entire codebase in the prompt. This pattern is highly useful for defining work to be done by code assistants like Claude Code or other MCP compatible coding agents, and reviewing the results ensuring they meet the exactly specified original requirements.

Features

  • Create Workplans: Creates detailed implementation plans based on a prompt and taking into consideration your entire codebase, posting them as GitHub issues and exposing them as MCP resources for your coding agent
  • Judge Code Diffs: Provides a tool to evaluate git diffs against the original workplan with full codebase context and provides detailed feedback, ensuring the implementation does not deviate from the original requirements and providing guidance on what to change to do so
  • Isolated Development Environments: Creates Git worktrees and linked branches for streamlined, isolated development workflow (can be done separately from workplan generation), allowing parallel development with multiple agents
  • Seamless GitHub Integration: Automatically creates labeled issues with proper branch linking in the GitHub UI, posts judgement sub-issues with references to original workplan issues.
  • 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 for Gemini models)
  • OPENAI_API_KEY: Your OpenAI API key (required for OpenAI models)
  • REPO_PATH: Path to your repository (defaults to current directory)
  • YELLHORN_MCP_MODEL: Model to use (defaults to "gemini-2.5-pro-preview-03-25"). Available options:
    • Gemini models: "gemini-2.5-pro-preview-03-25", "gemini-2.5-flash-preview-04-17"
    • OpenAI models: "gpt-4o", "gpt-4o-mini", "o4-mini", "o3"

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. Create a worktree for the workplan (optional):

    Please create a worktree for issue #123
    
  3. Navigate to the created worktree directory:

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

    # You can run this from anywhere
    Please get the workplan for issue #123
    
  5. 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]"
    
    # You can run this from anywhere
    Please judge the PR comparing "main" and "feature-branch" against the workplan in issue #123
    

Tools

create_workplan

Creates a GitHub issue with a detailed workplan based on the title and detailed description.

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
    • issue_number: The GitHub issue number

create_worktree

Creates a git worktree with a linked branch for isolated development from an existing workplan issue.

Input:

  • issue_number: The GitHub issue number for the workplan

Output:

  • JSON string containing:
    • worktree_path: Path to the created Git worktree directory
    • branch_name: Name of the branch created for the worktree
    • issue_url: URL to the associated GitHub issue

get_workplan

Retrieves the workplan content (GitHub issue body) associated with a workplan.

Input:

  • issue_number: The GitHub issue number for the workplan.

Output:

  • The content of the workplan issue as a string

judge_workplan

Triggers an asynchronous code judgement comparing two git refs (branches or commits) against a workplan described in a GitHub issue. Creates a GitHub sub-issue with the judgement asynchronously after running (in the background).

Input:

  • issue_number: The GitHub issue number for the workplan.
  • base_ref: Base Git ref (commit SHA, branch name, tag) for comparison. Defaults to 'main'.
  • head_ref: Head Git ref (commit SHA, branch name, tag) for comparison. Defaults to 'HEAD'.

Output:

  • A confirmation message that the judgement 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

# Run tests with coverage report
pytest --cov=yellhorn_mcp --cov-report term-missing

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 and yellhorn_mcp/init.py
  2. Update CHANGELOG.md with the new changes
  3. Commit changes: git commit -am "Bump version to X.Y.Z"
  4. Tag the commit: git tag vX.Y.Z
  5. Push changes and tag: git push && git push --tags

For a history of changes, see the Changelog.

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.3.0.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.3.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yellhorn_mcp-0.3.0.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.3.0.tar.gz
Algorithm Hash digest
SHA256 16d7ebf8048b73bbf46b5b2b5dd0bded4c23410e022d35cff90682a05541e808
MD5 a2deab06e67b633b4ec828be6d64e206
BLAKE2b-256 168dcb949b800305552afcb29516d41500f694311e95a04899399d698f7b51df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yellhorn_mcp-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 18.6 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c08bcfcbad5a7fef51170d2e8f83755594576ed65d25bb1e3b45a46003bbe501
MD5 5e63dc66e8a0bbbfd26e0017af5e6437
BLAKE2b-256 d7611ab90f58976bc2abd894993ccb8de15566763e3a8388b2690b9cf76e680e

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