Skip to content

Add Claude Code instructions to README #45

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

Open
Zander-Davidson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Claude Code instructions to README #45

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
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,31 @@ Create a file at `.cursor/mcp.json` in your project directory with the following
}
```

#### Option C: Configure with Claude Code

Run the following command to add godot-mcp to the MCP servers available to Claude Code:

```bash
claude mcp add godot-mcp --transport stdio -- node /absolute/path/to/godot-mcp/build/index.js
```

Alternatively, edit the list of available MCP servers in `~/.claude.json`:

```json
"mcpServers": {
"godot-mcp": {
"type": "stdio",
"command": "node",
"args": [
"/absolute/path/to/godot-mcp/build/index.js"
],
"env": {} // add optional environment variables here
}
},
```

Restart Claude Code after adding the MCP configuration.

### Step 3: Optional Environment Variables

You can customize the server behavior with these environment variables:
Expand Down