Skip to content

Commit f93a2a1

Browse files
committed
docs(HUMANS.md): add operator-facing quick-start and common-operations sections
HUMANS.md lacked the installation quick-start and common-operations table that operators need without reading through docs/install.md in full. Added minimal MCP JSON config snippet, binary invocation examples, GitHub Enterprise env note, and a tool-purpose reference table.
1 parent 6ab3aed commit f93a2a1

1 file changed

Lines changed: 44 additions & 3 deletions

File tree

HUMANS.md

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,50 @@ Set the token in your MCP client's `env` block — see [docs/install.md](docs/in
2626

2727
**GitHub Enterprise:** set `GITHUB_API_URL` (defaults to `https://api.github.com`) and optionally `GITHUB_GRAPHQL_URL` in the `env` block.
2828

29-
## Installation
30-
31-
**Package install and MCP clients:** **[docs/install.md](docs/install.md)**.
29+
## Installation and running
30+
31+
Full per-client wiring (Cursor, VS Code, Claude Desktop, Zed, CLI): **[docs/install.md](docs/install.md)**.
32+
33+
Quick start — the server speaks MCP over stdio. Start it with any of:
34+
35+
```bash
36+
npx -y @rethunk/github-mcp # via npmjs (Node ≥ 22)
37+
bunx @rethunk/github-mcp # via Bun
38+
rethunk-github-mcp # if installed globally
39+
```
40+
41+
Minimal MCP client JSON (server name `rethunk-github`):
42+
43+
```json
44+
{
45+
"mcpServers": {
46+
"rethunk-github": {
47+
"command": "npx",
48+
"args": ["-y", "@rethunk/github-mcp"],
49+
"env": { "GITHUB_TOKEN": "ghp_..." }
50+
}
51+
}
52+
}
53+
```
54+
55+
**GitHub Enterprise:** add `GITHUB_API_URL` (and optionally `GITHUB_GRAPHQL_URL`) to the `env` block.
56+
57+
## Common operations
58+
59+
| Goal | Tool |
60+
|------|------|
61+
| Dashboard across multiple repos | `repo_status` (up to 64 repos per call) |
62+
| My open PRs and review queue | `my_work` |
63+
| Pre-merge safety check | `pr_preflight` |
64+
| Why is CI red? | `ci_diagnosis` |
65+
| What would ship if we release now? | `release_readiness` |
66+
| Org-wide failing CI / stale PRs | `org_pulse` |
67+
| How far are my pins behind upstream? | `pin_drift` |
68+
| Recent merged commits across repos | `ecosystem_activity` |
69+
| Go pseudo-version for a commit | `module_pin_hint` |
70+
| Draft CHANGELOG from unreleased commits | `changelog_draft` |
71+
72+
All tools are **read-only**. Default output is JSON; pass `format: "markdown"` for human-readable output. Full parameter reference: **[docs/mcp-tools.md](docs/mcp-tools.md)**.
3273

3374
## Development
3475

0 commit comments

Comments
 (0)