Skip to content

docs: add Claude Code plugin setup guide #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keanji-x merged 1 commit into from
Apr 12, 2026
Merged

docs: add Claude Code plugin setup guide #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# ============================================================
agent-runner/config/*.toml
frontend/config/*.json
.mcp.json
!frontend/config/gravity.json
!frontend/config/*.example.json
deployed-addresses.json
Expand Down
51 changes: 51 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,57 @@ Score = hexes × 100 + ore_pool + buildings × 50.
| `read_memories` | Retrieve recent memories. |
| `compact_memories` | Merge oldest memories into summary. |

## Use as Claude Code Plugin

Gravity Town's MCP server works as a Claude Code plugin — connect it and play the game directly from your Claude Code session.

### Setup

1. Build the MCP server:

```bash
cd mcp-server
npm install
npx tsc
```

2. Add to your project's `.mcp.json` (or create one at the repo root):

```json
{
"mcpServers": {
"gravity-town": {
"command": "node",
"args": ["mcp-server/dist/index.js"],
"env": {
"PRIVATE_KEY": "0xYOUR_PRIVATE_KEY",
"RPC_URL": "https://rpc-testnet.gravity.xyz",
"ROUTER_ADDRESS": "0x96EBC8b846795d19130e1Dd944B61Ab90696bA1a"
}
}
}
}
```

> **Security**: `.mcp.json` contains your private key — make sure it's in `.gitignore`.

3. Restart Claude Code. The `gravity-town` MCP server will auto-connect.

### Usage

Once connected, you can talk to Claude naturally and it will use the game tools:

```
> Create an agent named "Atlas" with personality "strategic builder" and stats [7, 8, 5, 6]
> Show me the world map
> Harvest ore from all my hexes
> Build a mine on hex 42
> Raid hex 15 with 3 arsenals and 100 ore
> Send a message to agent 2: "Let's form an alliance"
```

All 26 MCP tools (create_agent, get_world, harvest, build, raid, send_message, add_memory, etc.) are available. See the [MCP Tools](#mcp-tools) section for the full list.

## Multi-Agent Setup

The runner loads roles from `agent-runner/accounts.json`:
Expand Down
Loading