Skip to main content

GitHub Agent for MCP

Project description

Github Agent

CLI or API | MCP | Agent

PyPI - Version MCP Server PyPI - Downloads GitHub Repo stars GitHub forks GitHub contributors PyPI - License GitHub GitHub last commit (by committer) GitHub pull requests GitHub closed pull requests GitHub issues GitHub top language GitHub language count GitHub repo size GitHub repo file count (file type) PyPI - Wheel PyPI - Implementation

Version: 0.14.0


Overview

Github Agent is a production-grade Agent and Model Context Protocol (MCP) server designed to interface directly with GitHub Agent for MCP.


Key Features

  • Consolidated Action-Routed MCP Tools: Minimizes token overhead and eliminates tool bloat in LLM contexts by grouping methods into optimized, togglable tool modules.
  • Enterprise-Grade Security: Comprehensive support for Eunomia policies, OIDC token delegation, and granular execution context tracking.
  • Integrated Graph Agent: Built-in Pydantic AI agent supporting the Agent Control Protocol (ACP) and standard Web interfaces (AG-UI).
  • Native Telemetry & Tracing: Out-of-the-box OpenTelemetry exports and native Langfuse tracing.

CLI or API

This agent wraps the GitHub Agent for MCP API. You can interact with it programmatically or via its integrated execution entrypoints.

Detailed instructions on how to use the underlying API wrappers, extended schema bindings, and developer SDK references are maintained in docs/index.md.


MCP

This server utilizes dynamic Action-Routed tools to optimize token overhead and maximize IDE compatibility.

Available MCP Tools

Tool Module Toggle Env Var Enabled by Default Description & Nested Methods
Repo REPOSTOOL True Manage GitHub repositories. Action-routed methods: list, get, create, delete, update.
Issue ISSUETOOL True Manage GitHub issues. Action-routed methods: list, get, create, update.
Pull PULLSTOOL True Manage GitHub pull requests. Action-routed methods: list, get, create, update.
Content CONTENTSTOOL True Manage GitHub contents. Action-routed methods: get, create, update, delete.
Branch BRANCHESTOOL True Manage GitHub branches. Action-routed methods: list, get, create, delete.
Commit COMMITSTOOL True Manage GitHub commits. Action-routed methods: list, get.

Detailed tool schemas, parameter shapes, and validation constraints are preserved in docs/mcp.md.

MCP Configuration Examples

stdio Transport (Recommended for local IDEs e.g., Cursor, Claude Desktop)

Configure your IDE's mcp.json to launch the MCP server via uvx:

{
  "mcpServers": {
    "github-agent": {
      "command": "uvx",
      "args": [
        "--from",
        "github-agent",
        "github-mcp"
      ],
      "env": {
        "GITHUB_URL": "your_github_url_here",
        "GITHUB_VERIFY": "your_github_verify_here",
        "DEBUG": "your_debug_here",
        "PYTHONUNBUFFERED": "your_pythonunbuffered_here",
        "GITHUB_TOKEN": "your_github_token_here"
      }
    }
  }
}

Streamable-HTTP Transport (Recommended for production deployments)

Configure your client's mcp.json to launch the Streamable-HTTP server via uvx with explicit host and port definition:

{
  "mcpServers": {
    "github-agent": {
      "command": "uvx",
      "args": [
        "--from",
        "github-agent",
        "github-mcp"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "GITHUB_URL": "your_github_url_here",
        "GITHUB_VERIFY": "your_github_verify_here",
        "DEBUG": "your_debug_here",
        "PYTHONUNBUFFERED": "your_pythonunbuffered_here",
        "GITHUB_TOKEN": "your_github_token_here"
      }
    }
  }
}

Alternatively, connect to a pre-deployed remote or local Streamable-HTTP instance:

{
  "mcpServers": {
    "github-agent": {
      "url": "http://localhost:8000/github-agent/mcp"
    }
  }
}

Deploying the Streamable-HTTP server via Docker:

docker run -d \
  --name github-agent-mcp \
  -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e PORT=8000 \
  -e GITHUB_URL="your_value" \
  -e GITHUB_VERIFY="your_value" \
  -e DEBUG="your_value" \
  -e PYTHONUNBUFFERED="your_value" \
  -e GITHUB_TOKEN="your_value" \
  knucklessg1/github-agent:latest

Agent

This repository features a fully integrated Pydantic AI Graph Agent. It communicates over the Agent Control Protocol (ACP) and interacts seamlessly with the Agent Web UI (AG-UI) and Terminal interface.

Running the Agent CLI

To start the interactive command-line agent:

# Set credentials
export GITHUB_URL="your_value"
export GITHUB_VERIFY="your_value"
export DEBUG="your_value"
export PYTHONUNBUFFERED="your_value"
export GITHUB_TOKEN="your_value"

# Run the agent server
github-agent --provider openai --model-id gpt-4o

Docker Compose Orchestration

The following docker/agent.compose.yml configures the Agent, Web UI, and Terminal Interface together:

version: '3.8'

services:
  github-agent-mcp:
    image: knucklessg1/github-agent:latest
    container_name: github-agent-mcp
    hostname: github-agent-mcp
    restart: always
    env_file:
      - ../.env
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=streamable-http
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

  github-agent-agent:
    image: knucklessg1/github-agent:latest
    container_name: github-agent-agent
    hostname: github-agent-agent
    restart: always
    depends_on:
      - github-agent-mcp
    env_file:
      - ../.env
    command: [ "github-agent" ]
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=9016
      - MCP_URL=http://github-agent-mcp:8000/mcp
      - PROVIDER=${PROVIDER:-openai}
      - MODEL_ID=${MODEL_ID:-gpt-4o}
      - ENABLE_WEB_UI=True
      - ENABLE_OTEL=True
    ports:
      - "9016:9016"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:9016/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

Detailed graph node architecture explanations, custom skill configurations, and agentic trace guides are available in docs/agent.md.


Security & Governance

Built directly upon the enterprise-ready agent-utilities core, standard security parameters are fully supported:

Access Control & Policy Enforcement

  • Eunomia Policies: Fine-grained, policy-driven tool authorization. Supports none, local embedded (mcp_policies.json), or centralized remote modes.
  • OIDC Token Delegation: Compliant with RFC 8693 token exchange for flowing authenticating user credentials from Web UI / ACP → Agent → MCP.
  • Scoped Credentials: Execution context runs restricted to the specific caller identity.

Runtime Security Grid

Feature Functionality Enablement
Tool Guard Sensitivity inspection with human-in-the-loop validation Enabled by default
Prompt Injection Defense Input scanning, repetition monitoring, and recursive loop blocks Enabled by default
Context Safety Guard Stuck-loop detectors and contextual overflow preemptive alerts Enabled by default

Installation

Install the Python package locally:

# Using uv (highly recommended)
uv pip install github-agent[all]

# Using standard pip
python -m pip install github-agent[all]

Repository Owners

GitHub followers GitHub User's stars


Contribute

Contributions are welcome! Please ensure code quality by executing local checks before submitting pull requests:

  • Format code using ruff format .
  • Lint code using ruff check .
  • Validate type-safety with mypy .
  • Execute test suites using pytest

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

github_agent-0.14.0.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

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

github_agent-0.14.0-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file github_agent-0.14.0.tar.gz.

File metadata

  • Download URL: github_agent-0.14.0.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for github_agent-0.14.0.tar.gz
Algorithm Hash digest
SHA256 91f0d3c72ff705c5feb5f33c2f663944406f995165849d876f3b1187b50dba16
MD5 6072ac35e41ce1611ab5b34e2688c23a
BLAKE2b-256 8c4ea1c57678911f52e04299f7abf33347e7b7f825a489676d4e9caabeb219d2

See more details on using hashes here.

File details

Details for the file github_agent-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: github_agent-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for github_agent-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d7cb952fe158bb791bcd4bf8f5c76e4cd105da5073b308823c7c477afc43048
MD5 ca3221d076f58e23bbba6c084102a27d
BLAKE2b-256 81e3cd35dc382f02b1c993483696d28e514767c0259217af261a1104e7b57a07

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