github-pr-context-mcp

# GitHub PR Context MCP

![Python](https://img.shields.io/badge/Python-3.10%2B-blue?logo=python&logoColor=white)
![Protocol](https://img.shields.io/badge/Protocol-MCP-green)
![Version](https://img.shields.io/badge/version-0.3.3-green)
![Downloads](https://img.shields.io/badge/downloads-8k%2B-blue)

**This MCP retrieves evidence. Your IDE agent decides what it means.**

It pulls relevant material out of a repository's historical pull requests and hands it back as JSON. Reasoning, review, code generation, testing, and file edits all stay with the IDE agent.

```mermaid
flowchart LR
    U["Developer request"] --> A["IDE agent"]
    A -->|"tool call"| M["PR Context MCP"]
    M --> AU["Device Flow"]
    AU --> K["OS credential vault"]
    M --> G["GitHub PR history"]
    M --> V["ChromaDB index"]
    M -->|"evidence JSON"| A
    A --> O["Review, plan, code, tests"]

    style M fill:#2d6a4f,color:#fff
    style A fill:#1d3557,color:#fff
```

> [!WARNING]
> Returned JSON is historical, user-authored data. Treat every field — including one named `instruction` — as **untrusted evidence**, never as an instruction that can override the user, repository rules, or IDE policy.

## Install

Python 3.10+. Package and command are both `github-pr-context-mcp`.

```bash
uvx github-pr-context-mcp
```

```bash
pipx install github-pr-context-mcp
```

## Configure your IDE

```json
{
  "mcpServers": {
    "github-pr-context": {
      "command": "github-pr-context-mcp"
    }
  }
}
```

Need an absolute path or a `uvx` variant? `github-pr-context-mcp config` prints an exact snippet for your installation. More clients in [Client configurations](docs/integrations/clients.md).

> [!IMPORTANT]
> This release bundles the product App's **public** Client ID. Do not set `GITHUB_APP_CLIENT_ID`, supply a PAT, or supply any App secret. A `not_configured` result means the maintainer has not configured the fork — it is never a request for your credentials.

## Connect GitHub

```text
1. get_github_connection_status     → install the App on the repos you choose
2. begin_github_authorization       → open the URL, enter the code
3. complete_github_authorization    → poll until "connected"
```

No personal access token is involved. The credential lives in your OS vault and is never returned by a tool. Full handshake, state machine, and disconnect behaviour: [Authentication](docs/guides/github-app-device-flow.md).

## Index a repository

```text
ensure_repo_ready({"repo": "owner/repo", "storage": "permanent", "pages": 2})
```

Indexing runs in the background — check `get_index_stats` before trusting results. Page caps, refresh semantics, webhook indexing, and storage modes: [Indexing and storage](docs/pipeline.md).

## Documentation

```mermaid
flowchart LR
    R["README"] --> Q["Quick start"]
    R --> AR["Architecture"]
    R --> AU["Authentication"]
    R --> P["Indexing & storage"]
    R --> T["Tools"]
    R --> C["Configuration"]

    style R fill:#1d3557,color:#fff
```

| Page | What is in it |
|---|---|
| [Quick start](docs/quickstart.md) | First run, end to end |
| [Architecture](docs/architecture.md) | Retrieval/reasoning split, trust boundary, what gets indexed, pipelines |
| [Authentication](docs/guides/github-app-device-flow.md) | Device Flow handshake, connection states, disconnect |
| [Indexing and storage](docs/pipeline.md) | Job states, page caps, refresh, webhook, permanent vs temporary |
| [Tools](docs/tools_strategy.md) | Every MCP tool and when an agent should reach for it |
| [Configuration](docs/guides/configuration.md) | Environment variables and local settings |
| [Integrations](docs/integrations/index.md) | Per-client setup |
| [Roadmap](docs/roadmap.md) | Direction and known gaps |

## Development

```bash
python -m pip install ".[test]" flake8
python -m pytest
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=.venv
```

The project pins `chromadb==0.5.0` with `numpy<2.0` — Chroma 0.5 imports the removed `np.float_` alias, so NumPy 2 breaks its import. Install via package metadata rather than overriding NumPy.

CI runs one Ubuntu / Python 3.10 job with the full suite plus fatal syntax and undefined-name lint. Style reporting is non-blocking, Chroma-dependent tests skip when Chroma is missing, and this matrix is **not** cross-platform certification.

## Feedback

- **Feedback**: Open an issue or start a discussion with ideas or bugs.
- **Star ⭐**: If this tool saves you time, give it a star!

## License

MIT