Skip to content

Commit 5024993

Browse files
AlbinoGeekclaude
andcommitted
docs: add README
Project overview, tool table, doc index with cross-links. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 55e7d30 commit 5024993

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# @rethunk/github-mcp
2+
3+
[![CI](https://github.com/Rethunk-AI/rethunk-github-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/Rethunk-AI/rethunk-github-mcp/actions/workflows/ci.yml)
4+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
5+
6+
**Rollup GitHub tools over MCP** — high-value composite operations that batch many GitHub API calls into single MCP tool invocations with concise, LLM-optimized output. Not 1:1 API wrappers; each tool replaces 3-6 round-trips.
7+
8+
**Repository:** [github.com/Rethunk-AI/rethunk-github-mcp](https://github.com/Rethunk-AI/rethunk-github-mcp) · **GitHub Packages (CI on each tag):** [`@rethunk-ai/github-mcp`](https://github.com/Rethunk-AI/rethunk-github-mcp/packages) — see [docs/install.md](docs/install.md) and [HUMANS.md](HUMANS.md) Publishing.
9+
10+
## Tools
11+
12+
| Tool | What it does |
13+
|------|-------------|
14+
| **`repo_status`** | Multi-repo dashboard: branch HEAD, CI, PRs, issues, latest commit — up to 20 repos in one call |
15+
| **`my_work`** | Cross-repo personal queue: your open PRs, review requests, assigned issues |
16+
| **`pr_preflight`** | Pre-merge safety check: mergeable, reviews, CI, behind-base, computed `safe` verdict |
17+
| **`release_readiness`** | What would ship now: unreleased commits, associated PRs, CI on head, diff stats |
18+
| **`ci_diagnosis`** | Why is CI red: failed run logs (tail-truncated), trigger commit, run URL |
19+
| **`org_pulse`** | Org-wide dashboard: failing CI, stale PRs, unreviewed PRs across all active repos |
20+
21+
All tools are **read-only** and support **markdown** (default) or **JSON** output.
22+
23+
## Documentation
24+
25+
| Doc | Audience |
26+
|-----|----------|
27+
| **[docs/install.md](docs/install.md)** | Prerequisites, running the package, every supported MCP client, troubleshooting |
28+
| **[docs/mcp-tools.md](docs/mcp-tools.md)** | Tool ids, parameters, JSON output shapes, error codes (canonical reference) |
29+
| **[HUMANS.md](HUMANS.md)** | Auth, dev commands, CI, publishing |
30+
| **[AGENTS.md](AGENTS.md)** | Contributors: implementation map, API strategy, contracts, CI |

0 commit comments

Comments
 (0)