Skip to content

Commit 3cc4386

Browse files
committed
consolidated the configuration documentation
1 parent aac5e32 commit 3cc4386

File tree

3 files changed

+19
-75
lines changed

3 files changed

+19
-75
lines changed

README.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -168,29 +168,7 @@ This repository includes an MCP (Model Context Protocol) server that provides AI
168168
- **Project detection**: Analyze projects to detect template, PHP version, framework
169169
- **Template comparison**: Compare projects against templates to find outdated files
170170

171-
### Installation
172-
173-
```bash
174-
# Build the MCP server
175-
cd mcp
176-
npm install
177-
npm run build
178-
```
179-
180-
Add to `~/.claude/settings.json`:
181-
182-
```json
183-
{
184-
"mcpServers": {
185-
"itkdev": {
186-
"command": "node",
187-
"args": ["/path/to/itkdev-docker/mcp/dist/index.js"]
188-
}
189-
}
190-
}
191-
```
192-
193-
See [mcp/README.md](mcp/README.md) for detailed documentation and [docs/rfc-mcp-server.md](docs/rfc-mcp-server.md) for the design rationale.
171+
See [mcp/README.md](mcp/README.md) for installation and configuration instructions, and [docs/rfc-mcp-server.md](docs/rfc-mcp-server.md) for the design rationale.
194172

195173
## Documentation
196174

docs/rfc-mcp-server.md

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -150,53 +150,7 @@ itkdev-docker/
150150

151151
### User Configuration
152152

153-
First, build the MCP server:
154-
155-
```bash
156-
cd /path/to/itkdev-docker/mcp
157-
npm install
158-
npm run build
159-
```
160-
161-
Then configure Claude Code using one of these methods:
162-
163-
#### Option 1: User-wide configuration (all projects)
164-
165-
Create or edit `~/.claude.json`:
166-
167-
```json
168-
{
169-
"mcpServers": {
170-
"itkdev": {
171-
"command": "node",
172-
"args": ["/path/to/itkdev-docker/mcp/dist/index.js"]
173-
}
174-
}
175-
}
176-
```
177-
178-
#### Option 2: Project-specific configuration
179-
180-
Create `.mcp.json` in your project root:
181-
182-
```json
183-
{
184-
"mcpServers": {
185-
"itkdev": {
186-
"command": "node",
187-
"args": ["/path/to/itkdev-docker/mcp/dist/index.js"]
188-
}
189-
}
190-
}
191-
```
192-
193-
#### Option 3: CLI command
194-
195-
```bash
196-
claude mcp add itkdev --scope user -- node /path/to/itkdev-docker/mcp/dist/index.js
197-
```
198-
199-
After configuration, restart Claude Code and run `/mcp` to verify the server is connected.
153+
See [mcp/README.md](../mcp/README.md) for build and configuration instructions.
200154

201155
## Use Cases
202156

mcp/README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,34 +26,46 @@ npm run build
2626

2727
### Configure Claude Code
2828

29-
Add to `~/.claude/settings.json`:
29+
Configure Claude Code using one of these methods:
30+
31+
#### Option 1: User-wide configuration (all projects)
32+
33+
Create or edit `~/.claude.json`:
3034

3135
```json
3236
{
3337
"mcpServers": {
3438
"itkdev": {
3539
"command": "node",
36-
"args": ["/absolute/path/to/itkdev-docker/mcp/dist/index.js"]
40+
"args": ["/path/to/itkdev-docker/mcp/dist/index.js"]
3741
}
3842
}
3943
}
4044
```
4145

42-
Replace `/absolute/path/to/itkdev-docker` with the actual path to your itkdev-docker clone.
46+
Replace `/path/to/itkdev-docker` with the actual path to your itkdev-docker clone.
4347

44-
**Example:**
48+
#### Option 2: Project-specific configuration
49+
50+
Create `.mcp.json` in your project root:
4551

4652
```json
4753
{
4854
"mcpServers": {
4955
"itkdev": {
5056
"command": "node",
51-
"args": ["/Users/developer/itkdev-docker/mcp/dist/index.js"]
57+
"args": ["/path/to/itkdev-docker/mcp/dist/index.js"]
5258
}
5359
}
5460
}
5561
```
5662

63+
#### Option 3: CLI command
64+
65+
```bash
66+
claude mcp add itkdev --scope user -- node /path/to/itkdev-docker/mcp/dist/index.js
67+
```
68+
5769
### Verify Installation
5870

5971
Restart Claude Code and check that the MCP server is connected. You can ask Claude:

0 commit comments

Comments
 (0)