GitHub (read-only)

io.github.AbdulMuhaiminKhanv1.2.0更新于 Oct 8, 2026

Read-only GitHub repos, issues, PRs and commits, with tool descriptions tuned on a benchmark.

已验证STDIO仅桌面Developer ToolsKnowledge & Memory

概览

AI 生成的概览

为助手提供只读的 GitHub 访问:列出仓库、查看仓库信息、浏览未关闭议题、搜索议题、列出拉取请求和查看最近提交。

功能
一个本地 stdio MCP 服务器,提供六个只读 GitHub 工具:list_repositories、get_repository、list_open_issues、search_issues、list_pull_requests 和 get_recent_commits。它返回带精确总数的紧凑 JSON,处理分页、重试、速率限制和 ETag 缓存,并优化了工具描述,使模型能选对工具和参数。它还附带用于评估工具选择的基准测试工具。
适用场景
当助手需要在不具备写权限的情况下回答关于你的 GitHub 仓库、议题、拉取请求和提交的问题时使用。适合只读浏览和查询,不适合创建、编辑或合并任何内容。
运行要求
通过 stdio 在本地运行,通常使用 uvx 从 PyPI 包 github-mcp-readonly 或 Git 仓库启动;直接安装需要 Python 3.10+。需要一个细粒度的 GitHub 令牌,具有对 Metadata、Contents、Issues 和 Pull requests 的只读权限,通过环境变量 GITHUB_TOKEN 提供。需要访问 GitHub REST API 的网络连接。GITHUB_MCP_TOOLSET 可选,用于选择工具描述版本。
安装前请注意
GITHUB_TOKEN 是凭据,必须是细粒度的只读令牌;它保留在服务器进程中,不会发送给模型。该服务器为只读,不会写入、发送或删除数据。较长的工具描述会使每次请求增加约 920 个输入 token,分页在每个列表 500 项处停止,更大的总数会报告为下限。

安装

在 SourceWeft 中

  1. 打开 控制台中的 GitHub (read-only),将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

GitHub MCP Server: Teaching an AI to Pick the Right Tool

[test] [python] [mcp] [cost] [license]

A read-only Model Context Protocol server that lets Claude (or any MCP client) answer questions about my GitHub repos, issues, pull requests and commits. It comes with a benchmark that measures how often the model picks the right tool with the right arguments.

Rewriting the tool descriptions took a local 7B model from 63% to 95% correct, and from 60% to 90% on held-out questions it was never tuned on. An ablation shows where those 32 points came from, and most of them were not the prose:

ChangePointsWhat it was
Accept bare repo names (mcp-bench-app, not only owner/mcp-bench-app)+17input handling in the server
Write the range (1-50) into the limit parameter's description+8one parameter sentence
Rewrite the tool descriptions (when to use, when NOT to, and the alternative)+7the tool wording

Every miss left in v2 is the model asking for something the API doesn't offer: merged PRs, sorting by stars, or closed issues from the open-issues tool. Better wording can't fix those. The next step is to support them in the schema.

Explore every question in the results dashboard →

[Outcome shares per configuration]

What I built

  • MCP server (Python, mcp SDK 2.x) with 6 read-only tools over stdio: list_repositories, get_repository, list_open_issues, search_issues, list_pull_requests, get_recent_commits.
  • Least-privilege access: a fine-grained, read-only GitHub token and readOnlyHint annotations. The token stays in the server process and never reaches the model.
  • Production behaviour: schema-validated inputs, retries with backoff and jitter, primary and secondary rate-limit handling, ETag caching (304s don't count against the rate limit), exact totals for list tools, and error messages that tell the model how to recover.
  • A benchmark with known answers: a seed script creates two repos with 15 issues, 5 pull requests and commits from two authors. A fake GitHub API serves the same data offline, so the benchmark also runs in CI with no token.
  • Three evaluations: tool selection with argument grading (60 questions), a held-out set (20), and multi-step agent runs whose final answers are checked against the seeded facts (13).
  • An ablation (v1 → v1b → v2) that separates input handling from description wording.
  • An automatic description optimizer that rewrites descriptions from failures and keeps a change only if held-out accuracy doesn't drop.
  • A harness that benchmarks any MCP server, not just this one (examples/).
  • A results dashboard (docs/) with every question, call and error from the runs.
  • Tests and CI on Python 3.10–3.13 (ruff, mypy, pytest, and an oracle check that the harness scores 100% when the right call is made).

Architecture

mermaid
flowchart LR    U[User] -->|question| C["Claude Desktop<br/>(MCP client)"]    C <-->|"JSON-RPC over stdio<br/>tools/list · tools/call"| S["github-mcp<br/>Python MCP server"]    S -->|"HTTPS · read-only token<br/>ETags · retries"| G[(GitHub REST API)]    E["eval/run_eval.py"] -.->|"same MCP protocol"| S    E -.->|"question + tool schemas"| L["LLM under test<br/>(Ollama or Claude)"]    S -.->|"GITHUB_API_URL (CI)"| F[("fake GitHub<br/>seeded repos")]
LayerResponsibility
server.pyRegisters tools, validates arguments, returns compact JSON with exact totals
descriptions.pyVersioned descriptions (v1 baseline, v1b ablation, v2 optimized, or a JSON file)
github_client.pyAuth, pagination, retries, rate limits, ETag cache, typed errors
eval/Benchmark runner, argument grader, seed script, fake GitHub, optimizer, chart, dashboard export

Evaluation

Method. Each question goes to the model with the server's own tool list, exactly what Claude Desktop sends. The harness executes the chosen call through MCP and grades it:

  • ✅ Correct: expected tool, call succeeded, arguments match (e.g. "last 3 days" → since_days=3)
  • 🟡 Wrong Arguments: right tool, call succeeded, but an argument is wrong or missing
  • ⚠️ Wrong Tool: a different tool, or no tool
  • ❌ Tool Failed: right tool, but the call returned an error

There are 60 questions (10 per tool, a third of them in deliberate overlap zones between tools), plus 20 held-out questions written after v2 was frozen and never used for tuning. The data is the seeded benchmark repos on real GitHub, and the model runs locally with Ollama at temperature 0, 3 runs per configuration, medians reported. The three runs differed by at most 2 points on the main set and 5 on held-out.

Configuration (qwen2.5:7b)CorrectWrong ArgumentsWrong ToolTool FailedInput tokens
v1: vague descriptions63%0%8%28%614
v1b: v1 + bare repo names80%0%8%12%614
v2: rewritten descriptions95%0%2%3%1533
v1 on held-out questions60%5%15%20%613
v2 on held-out questions90%0%5%5%1532

The offline run against the fake GitHub gave the same picture (65% / 82% / 95%).

A second model, llama3.1:8b, same questions and settings:

Configuration (llama3.1:8b)CorrectWrong ArgumentsWrong ToolTool FailedInput tokens
v1: vague descriptions32%7%12%50%643
v1b: v1 + bare repo names47%7%12%35%643
v2: rewritten descriptions92%5%2%2%1559
v2 on held-out questions95%0%0%5%1558

Llama picked the right tool 88% of the time even on v1. It failed on arguments: it asked for limit=100 on tools capped at 50 again and again, and passed owner/repo where a bare name was expected. The fixes that helped qwen (bare names, the stated limit range) helped llama even more, so the lesson carries across models: spell out argument constraints, not just what the tool does.

Agent mode (13 multi-step questions, answers checked against the seeded data): v1 62%, v2 69%. With 13 questions one answer is 8 points, so that difference is within noise (offline it went the other way).

Cost of better descriptions: v2 adds about 920 input tokens to every request (614 → 1533).

Raw results, one JSON row per question per run: eval/results/.

Benchmark your own MCP server

The harness isn't tied to this server. Give it the command that starts any stdio MCP server and a JSONL file of questions:

bash
python eval/run_eval.py --server "npx -y @modelcontextprotocol/server-filesystem ." \    --questions my_questions.jsonl --domain "the user's files" --backend ollama --runs 3

examples/ has a small notes server with 10 questions and the question format.

Decision File

1. Why the model picked the wrong tool

Every wrong-tool pick from the v1b run (3 of 3 runs each), and what v2 did about it:

QuestionExpected → chosenRoot causeAfter v2
"What's the exact name of my portfolio website repo?"list_repositories → get_repositoryv1's "Gets info about a repo" invited guessing a name (portfolio-website) instead of listingfixed
"Which repos haven't I pushed to in a long time?"list_repositories → get_recent_commits"Gets recent activity for a repo" sounded like the answer; nothing said repos can be sorted by last pushfixed
"What topics are tagged on mcp-bench-app?"get_repository → search_issues"Searches GitHub" read as a catch-all for anything about a repofixed
"What's the newest issue someone opened on mcp-bench-app?"list_open_issues → search_issuesThe model reached for search and invented query syntax (created:desc)fixed
"Which issues have been closed in mcp-bench-app?"search_issues → list_open_issuesThe model passed state: "closed" to the open-issues tool, trusting its own argument over the tool's namestill wrong, also on held-out

2. What the ablation showed

With an oracle that always picks the right tool, v1 scores 83%: all 10 bare-name questions fail because v1 requires owner/name. So part of any v1 → v2 gain was always going to be input handling. v1b (v1 text + bare names) separates the two:

  • v1 → v1b: +17 points. All 10 bare-name questions went from ❌ to ✅. The wording didn't change at all.
  • v1b → v2: +15 points, from 9 questions:
    • 5 were one parameter sentence. v1's limit said "How many." The model asked for 100, the schema allows 50, and the call failed. v2 says "(1-50)" and those 5 questions pass.
    • 4 were the tool wording: the first four rows of the table above.

The model rarely picked the wrong tool even with vague descriptions (92% right tool on v1). Most of the failures came from calls the server rejected.

3. What I changed

  1. Each description states what it returns, when to use it, and when NOT to use it, naming the alternative, e.g. list_open_issues: "Do NOT use for closed issues, keyword search, or issues across all repos (use search_issues), or for pull requests (use list_pull_requests)."
  2. Boundaries are mutually exclusive along one axis each: open vs closed, one repo vs all repos, keyword vs none, metadata vs history, issues vs PRs.
  3. Every parameter documents its format and range with an example. This turned out to matter more than the tool text.
  4. Behaviour fixes, reported separately: bare repo names resolve to the user's repo, and list tools return exact totals instead of a page-sized count.
  5. Error messages carry a next step ("Call list_repositories to check the exact name").

4. The automatic optimizer overfit, and the guard caught it

eval/optimize.py shows a model its training failures, asks it to rewrite the descriptions, and keeps a candidate only if training accuracy rises and held-out accuracy doesn't drop. Starting from v1, with qwen2.5:7b rewriting its own tools (offline data, 4 iterations):

IterationTrain (60)Held-out (20)Kept
0 (v1)65%60%baseline
170%55%no
267%50%no
372%40%no
472%40%no

Every rewrite raised training accuracy and lowered held-out accuracy, so the guard rejected all of them. The 7B model wrote descriptions that fit the questions it had just seen, not the tools. Without the held-out check, iteration 3 would have looked like a 7-point win. The hand-written v2 is what generalized.

5. What's left, and trade-offs

  • The 3 remaining v2 misses all ask for something the API doesn't have: state: "merged" for pull requests, sort: "stars" for repos, and state: "closed" on the open-issues tool. I didn't reword around them, because that would tune to these exact questions. The right fix is in the schema: accept merged (filter on merged_at), sort by stars client-side, and let the issues tool take a state.
  • Longer descriptions cost about 920 tokens per request. That's worth it at 6 tools. With dozens of tools I'd move to tool search and deferred loading.
  • Agent mode needs more questions before its numbers mean anything (13 is too few).
  • Pagination stops at 500 items per list (5 pages); totals beyond that are reported as lower bounds.

Use it

From Claude Desktop, add this to claude_desktop_config.json (or point command at a local install, as in this example):

json
{  "mcpServers": {    "github": {      "command": "uvx",      "args": ["--from", "git+https://github.com/AbdulMuhaiminKhan/github-mcp", "github-mcp"],      "env": { "GITHUB_TOKEN": "github_pat_... (fine-grained, read-only)" }    }  }}

Or with Docker: docker build -t github-mcp ., then claude_desktop_config.docker.example.json. GUIDE.md covers token permissions, the seed script and the full eval workflow (WINDOWS.md for PowerShell).

Run the benchmark yourself

bash
python3 -m venv .venv && source .venv/bin/activatepip install -e '.[dev,eval,plot]'pytest -q
# No token needed: the offline benchmark repos and a free local modelollama pull qwen2.5:7bpython eval/run_eval.py --fake-github --toolset v1 --runs 3python eval/run_eval.py --fake-github --toolset v2 --runs 3python eval/run_eval.py --fake-github --toolset v2 --questions eval/heldout.jsonlpython eval/run_eval.py --fake-github --mode agent --toolset v2
# Against real GitHub: seed the repos once (see GUIDE.md), then drop --fake-githubpython eval/seed_repos.py
# Rebuild the chart and the dashboard from your resultspython eval/plot_results.py eval/results/select-*.jsonl -o docs/results.pngpython eval/export_dashboard.py

Tech

Python 3.10+ · MCP Python SDK 2.x · httpx · pydantic · GitHub REST API · pytest · ruff · mypy · GitHub Actions · Ollama / Anthropic API for evaluation · matplotlib · vanilla JS dashboard

来源:README.md,提交 d8a6e74

工具

0
工具元数据尚未被收录。

版本历史

1
  1. v1.2.0最新Oct 8, 2026