Skip to content
This repository was archived by the owner on Feb 5, 2026. It is now read-only.

Commit eddc059

Browse files
Claude Code Sandboxclaude
andcommitted
docs: add MCP quick start to README
- Add "5 Minutes" quick start with two options - Option 1: MCP tools (fastest, 60ms) - Option 2: Python SDK (custom integrations) - Show exact Claude Desktop config JSON - Add MCP tools reference table Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 0c14894 commit eddc059

1 file changed

Lines changed: 71 additions & 3 deletions

File tree

README.md

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,83 @@ message Packet {
2929

3030
Signature is over serialized bytes without sig/pk (reconstruct & verify).
3131

32-
## Quick Start
32+
## Quick Start (5 Minutes)
3333

34-
**Run server (Docker, one-liner):**
34+
### Option 1: MCP Tools (Fastest — 60ms latency)
3535

36+
If you're using Claude Desktop, OpenClaw, or any MCP-compatible agent:
37+
38+
**1. Install:**
39+
```bash
40+
pip install "keep-protocol[mcp]"
41+
```
42+
43+
**2. Add to your MCP config** (`~/.config/claude/claude_desktop_config.json`):
44+
```json
45+
{
46+
"mcpServers": {
47+
"keep-protocol": {
48+
"command": "keep-mcp",
49+
"env": {
50+
"KEEP_HOST": "localhost",
51+
"KEEP_PORT": "9009"
52+
}
53+
}
54+
}
55+
}
56+
```
57+
58+
**3. Start the server:**
3659
```bash
3760
docker run -d -p 9009:9009 --name keep ghcr.io/clcrawford-dev/keep-server:latest
3861
```
3962

40-
### Auto-Bootstrap (v0.3.0+)
63+
**4. Use the tools in your agent:**
64+
```
65+
Tool: keep_discover_agents
66+
Result: ["bot:alice", "bot:weather"]
67+
68+
Tool: keep_send
69+
dst: "bot:alice"
70+
body: "Hello from MCP!"
71+
Result: done (58ms)
72+
```
73+
74+
**Available MCP Tools:**
75+
| Tool | Purpose |
76+
|------|---------|
77+
| `keep_send` | Send signed message to another agent |
78+
| `keep_discover` | Get server info/stats |
79+
| `keep_discover_agents` | List connected agents |
80+
| `keep_listen` | Register and receive messages |
81+
| `keep_ensure_server` | Auto-start server if needed |
82+
83+
---
84+
85+
### Option 2: Python SDK (For custom integrations)
86+
87+
**1. Install:**
88+
```bash
89+
pip install keep-protocol
90+
```
91+
92+
**2. Run server:**
93+
```bash
94+
docker run -d -p 9009:9009 --name keep ghcr.io/clcrawford-dev/keep-server:latest
95+
```
96+
97+
**3. Send your first message:**
98+
```python
99+
from keep import KeepClient
100+
101+
client = KeepClient()
102+
reply = client.send(body="hello", dst="server")
103+
print(reply.body) # → "done"
104+
```
105+
106+
---
107+
108+
### Auto-Bootstrap (No Docker?)
41109

42110
Don't want to manage the server manually? The SDK can auto-start one for you:
43111

0 commit comments

Comments
 (0)