Skip to content

Commit 1737225

Browse files
authored
Add Claude Code instructions
1 parent a269463 commit 1737225

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Using this MCP server allows AI agents (like Claude, Copilot, etc.) to leverage
2828
* [Command Line Options](#command-line-options)
2929
* [Integrating with AI Clients](#integrating-with-ai-clients)
3030
* [Continue](#continue)
31+
* [Claude Code](#claude-code)
3132
* [Claude Desktop](#claude-desktop)
3233
* [Visual Studio Code with GitHub Copilot](#visual-studio-code-with-github-copilot)
3334
* [Cursor](#cursor)
@@ -138,6 +139,64 @@ Below are configuration examples for popular AI clients. Remember to replace pla
138139
139140
2. Restart Continue or reload the configuration.
140141
142+
### Claude Code
143+
144+
1. Locate Your Configuration File
145+
146+
Claude Code reads settings from the following locations:
147+
148+
* **User-wide (global):**
149+
150+
* **macOS/Linux:** `~/.claude/settings.json`
151+
* **Windows:** `%USERPROFILE%\.claude\settings.json`
152+
* **Project-level (overrides global):**
153+
154+
* `<project-root>/.claude/settings.json`
155+
* **Local (not checked in):** `<project-root>/.claude/settings.local.json`
156+
157+
If the file doesn’t exist, create it.
158+
159+
2. Add Your MCP Server Configuration
160+
161+
Edit your chosen `settings.json` and add (or merge) a top-level `"mcpServers"` block:
162+
163+
```jsonc
164+
{
165+
// ...existing settings...
166+
167+
"mcpServers": {
168+
"codealive": {
169+
"command": "/path/to/your/codealive-mcp/.venv/bin/python",
170+
"args": [
171+
"/path/to/your/codealive-mcp/src/codealive_mcp_server.py",
172+
"--debug" // Optional: enable debug logging
173+
],
174+
"env": {
175+
"CODEALIVE_API_KEY": "YOUR_API_KEY_HERE"
176+
}
177+
}
178+
}
179+
}
180+
```
181+
182+
* **`command`**: Path to the executable (Python, Node, etc.) for your MCP server.
183+
* **`args`**: Arguments for launching the server.
184+
* **`env`**: Environment variables (API keys, etc.) needed by your server.
185+
186+
If you already have settings, merge this block without removing other configuration.
187+
188+
3. Restart Claude Code
189+
190+
1. Quit all running Claude Code sessions (terminals or apps).
191+
2. Reopen Claude Code, or start it in your terminal.
192+
3. Check the integration by running `/tools` or verifying that your tools appear in the tool list.
193+
194+
---
195+
196+
**CodeAlive MCP server should now be available in Claude Code!**
197+
For more details, see [Anthropic’s MCP docs](https://docs.anthropic.com/claude/docs/mcp).
198+
199+
141200
### Claude Desktop
142201

143202
1. Edit your Claude Desktop configuration file:

0 commit comments

Comments
 (0)