diff --git a/README.md b/README.md index 1e15298..877baee 100644 --- a/README.md +++ b/README.md @@ -18,18 +18,27 @@ Shall we get started? I speak through Blueโ€”a sheep from Stonehenge who is your very best friend. +## Install + +```bash +./install.sh +``` + +Installs CLI to `/usr/local/bin` and configures MCP for Claude Code. See [INSTALL.md](INSTALL.md) for details. + ## Getting Started ```bash -๐Ÿ’™ init # Welcome home -๐Ÿ’™ create # Start a new idea -๐Ÿ’™ plan # Break it into steps -๐Ÿ’™ status # Where are we? -๐Ÿ’™ next # What's next? +blue init # Welcome home +blue create # Start a new idea +blue plan # Break it into steps +blue status # Where are we? +blue next # What's next? ``` -## The 13 Beliefs +## The Beliefs +0. **Never Give Up** โ€” The ground everything stands on 1. **Purpose** โ€” We exist to make work meaningful and workers present 2. **Presence** โ€” The quality of actually being here while you work 3. **Home** โ€” You are never lost. You are home. @@ -44,6 +53,46 @@ I speak through Blueโ€”a sheep from Stonehenge who is your very best friend. 12. **Faith** โ€” Act on justified belief, not just proven fact 13. **Overflow** โ€” Build from fullness, not emptiness +## MCP Tools + +Blue speaks to Claude via MCP (Model Context Protocol). Eight tools for cross-repo coordination: + +| Tool | What it does | +|------|--------------| +| `realm_status` | Realm overview with repos, domains, contracts | +| `realm_check` | Validate contracts for CI | +| `contract_get` | Get contract details and schema | +| `session_start` | Begin a work session | +| `session_stop` | End session with summary | +| `realm_worktree_create` | Create worktrees for multi-repo work | +| `realm_pr_status` | Check PR readiness across repos | +| `notifications_list` | List contract change notifications | + +See [docs/mcp](docs/mcp/) for full documentation. + +### Quick Setup + +```bash +# Build Blue +cargo build --release + +# Configure Claude Code (~/.config/claude-code/mcp.json) +{ + "mcpServers": { + "blue": { + "command": "blue", + "args": ["mcp"] + } + } +} +``` + +Then in Claude: +``` +Human: What's my realm status? +Claude: [calls realm_status] You're in aperture/blue... +``` + ## Blue I have a warm, plausible British accent. Not posh, not mockneyโ€”just genuinely kind, a bit weathered from standing in fields near ancient stones, and quietly wise.