Skip to content

Commit 29ceec9

Browse files
committed
docs(humans): add prerequisites, running, and common operations sections
HUMANS.md had an installation pointer but no prerequisites, running, or common operations sections — leaving operators without the minimum context needed to start. Adds a Prerequisites section (Node ≥22, git on PATH), a Running the server section with npx/bunx quick-start commands, and a Common operations table summarising all 14 registered tools by function. Full parameter detail continues to live in docs/mcp-tools.md; the new sections point there.
1 parent ca4c177 commit 29ceec9

1 file changed

Lines changed: 43 additions & 2 deletions

File tree

HUMANS.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,54 @@ Example `git_parity` batch using the same pair in each sibling clone:
121121

122122
`absoluteGitRoots` is read-only by design. Mutating tools such as **`batch_commit`**, **`git_push`**, **`git_merge`**, and **`git_cherry_pick`** omit it from their schema; use `workspaceRoot` or MCP roots for writes. Full parameter rules and error codes live in **[docs/mcp-tools.md](docs/mcp-tools.md#absoluteGitRoots-sibling-clones)**.
123123

124+
## Prerequisites
125+
126+
- **Git** on `PATH` (`git --version`). Missing git → all tools return `git_not_found`.
127+
- **Node.js ≥ 22** (for `npx`) or **Bun** (for `bunx`). See `engines` in `package.json`.
128+
- No other runtime dependencies; the server is a self-contained MCP stdio process.
129+
130+
## Running the server
131+
132+
The server is a **stdio** MCP process — your MCP client starts it. You do not run it directly. Quick start:
133+
134+
```bash
135+
# npmjs (public, may lag tags)
136+
npx -y @rethunk/mcp-multi-root-git
137+
138+
# GitHub Packages (CI-aligned, every tag)
139+
npx -y @rethunk-ai/mcp-multi-root-git # requires ~/.npmrc with @rethunk-ai registry token
140+
```
141+
142+
Add the server to your MCP client config under a stable name (e.g. `rethunk-git`). Full per-client config (Cursor, VS Code, Claude Desktop, Zed): **[docs/install.md](docs/install.md)**.
143+
144+
## Common operations
145+
146+
Call tools by their registered id (prefix depends on client config name):
147+
148+
| Operation | Tool |
149+
|-----------|------|
150+
| Check status across workspace roots | `git_status` |
151+
| Status + ahead/behind for submodules | `git_inventory` |
152+
| Compare HEAD between path pairs | `git_parity` |
153+
| List preset names | `list_presets` |
154+
| View commit log | `git_log` |
155+
| View diff | `git_diff_summary` |
156+
| Create commits | `batch_commit` |
157+
| Push a branch | `git_push` |
158+
| Merge branches | `git_merge` |
159+
| Cherry-pick commits | `git_cherry_pick` |
160+
| Soft-reset HEAD | `git_reset_soft` |
161+
| Manage worktrees | `git_worktree_list` / `git_worktree_add` / `git_worktree_remove` |
162+
163+
Full parameter tables and JSON shapes: **[docs/mcp-tools.md](docs/mcp-tools.md)**.
164+
124165
## `git_not_found`
125166

126-
If **`git`** is missing or not runnable, tools and the presets resource respond with **`git_not_found`**. Prerequisites and `PATH`: **[docs/install.md](docs/install.md)**.
167+
If **`git`** is missing or not runnable, tools and the presets resource respond with **`git_not_found`**. Ensure `git` is on `PATH` in the environment that launches the MCP server.
127168

128169
## Installation
129170

130-
**Package install and MCP clients:** **[docs/install.md](docs/install.md)**.
171+
**Full install instructions and MCP client wiring:** **[docs/install.md](docs/install.md)**.
131172

132173
## Development
133174

0 commit comments

Comments
 (0)