Skip to content

Commit caf0b67

Browse files
committed
Edit specialized READMEs
Changes to be committed: modified: templates/README.md modified: tests/README.md
1 parent a3d2730 commit caf0b67

2 files changed

Lines changed: 197 additions & 128 deletions

File tree

templates/README.md

Lines changed: 79 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,97 @@
11
# MCP Configuration Templates
22

3-
This folder contains MCP server configuration templates for different editors and clients.
4-
53
## Quick Setup
64

7-
### VS Code (verified)
8-
1. Copy `vscode-mcp.json` to `.vscode/mcp.json` in your project root
9-
2. Start the server either directly from the file (toggles appear above the server name) or the Extensions icon (right-click on the server)
5+
Ready-to-use configuration templates are available in the `templates/` folder:
6+
7+
- **VS Code**: Copy `templates/vscode-mcp.json` to `.vscode/mcp.json`
8+
- **Claude Desktop**: Copy content from `templates/claude-desktop-mcp.json` to your Claude config
9+
- **Neovim**: Use `templates/neovim-mcp.json` as a starting point
10+
11+
### Individual Servers (Testing)
12+
13+
For testing specific parsers, you can add individual server configurations, based on the example templates, provided.
14+
Here is an example for VS Code:
15+
16+
```json
17+
{
18+
"servers": {
19+
"parse-patrol": {
20+
"command": "uv",
21+
"args": ["run", "python", "-m", "parse_patrol"],
22+
"cwd": "/path/to/parse-patrol"
23+
},
24+
"parse-patrol-cclib": {
25+
"command": "uv",
26+
"args": ["run", "python", "-m", "parse_patrol.parsers.cclib"],
27+
"cwd": "/path/to/parse-patrol"
28+
},
29+
"parse-patrol-nomad": {
30+
"command": "uv",
31+
"args": ["run", "python", "-m", "parse_patrol.databases.nomad"],
32+
"cwd": "/path/to/parse-patrol"
33+
}
34+
}
35+
}
36+
```
37+
38+
## VS Code (verified)
39+
40+
### Starting the Server
41+
42+
#### Locally
43+
44+
1. Copy `vscode-mcp.json` to `.vscode/mcp.json` in your project root.
45+
2. Start the server either directly from the file (toggles appear above the server name) or the Extensions icon (right-click on the server for all options).
1046
3. Use Agent mode in Copilot Chat to access parse-patrol tools
1147

48+
![mcp.json](assets/images/mcp_json.png)
49+
50+
#### Remotely
51+
52+
In VS Code, go to the command prompt, type `> mcp` and select "MCP: Open Remote User Configuration".
53+
It will open up a `mcp.json` file, where you can paste in your MCP server configurations.
54+
55+
### Using the Agent
56+
57+
Once the server is started, it will be available under the `CHAT` tab when running `Agent` mode.
58+
Note that the default mode for co-pilot is `Ask/Edit` mode.
59+
60+
To access *resources* type the pound symbol (`#`), for prompt commands type slash (`/`) in the chat window and wait for auto-complete.
61+
All resources and prompts names should start with `mcp.parse-patrol`.
62+
(Note that the MCP server name may change when published under a different or multiple servers.)
63+
64+
When executing a prompt command, the input parameters will pop up at the top.
65+
Their names and descriptions are outlined above the active text bar.
66+
Input parameters may be required or optional (marked as such) input.
67+
In the case of the later, the field can be left blank.
68+
Finally, the full prompt will be returned to the chat input field, ready to be submitted.
69+
Reviewing or editing is still possible at this step.
70+
71+
PITFALL: do not use the file explorer for adding fields, but the resource dialog.
72+
Else you copy-paste the file contents, NOT the file path.
73+
1274
### Claude Desktop (experimental)
1375

14-
**Option 1: Project-scoped (Recommended)**
76+
**Option 1: Project-scoped (Recommended):**
77+
1578
```bash
1679
# From your parse-patrol project directory
1780
# First ensure dependencies are installed
1881
uv sync --extra mcp
1982

2083
# Add the MCP server - use absolute path to ensure correct environment
2184
claude mcp add parse-patrol --scope project -- sh -c "cd $(pwd) && PYTHONPATH=src uv --project $(pwd) run python -m parse_patrol"
22-
23-
# Alternative: Use the venv python directly
24-
# claude mcp add parse-patrol --scope project -- sh -c "cd $(pwd) && PYTHONPATH=src $(pwd)/.venv/bin/python -m parse_patrol"
2585
```
2686

2787
**Environment Issues:**
88+
2889
- The `claude mcp add` command may run in a different `uv` environment than your project
2990
- Using `--project $(pwd)` ensures `uv` uses the correct project environment
3091
- Alternatively, use the venv Python directly: `.venv/bin/python`
3192

32-
**Option 2: Manual configuration**
93+
**Option 2: Manual configuration:**
94+
3395
1. Copy `claude-desktop-mcp.json` content to your Claude Desktop configuration file:
3496
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
3597
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
@@ -38,6 +100,7 @@ claude mcp add parse-patrol --scope project -- sh -c "cd $(pwd) && PYTHONPATH=sr
38100
3. Restart Claude Desktop
39101

40102
**Troubleshooting Claude MCP:**
103+
41104
- **Environment mismatch**: If "No module named 'mcp'" error, the `uv` environment differs from your project
42105
- Use `uv --project $(pwd) run` or direct venv path: `.venv/bin/python`
43106
- Test manually: `cd /your/project && PYTHONPATH=src uv run python -m parse_patrol`
@@ -46,48 +109,21 @@ claude mcp add parse-patrol --scope project -- sh -c "cd $(pwd) && PYTHONPATH=sr
46109
- Verify imports work: `PYTHONPATH=src uv run python -c "import parse_patrol.__main__"`
47110
- **Server doesn't sync**: Try restarting Claude Desktop after adding the server
48111

49-
### Neovim (with MCP support) (experimental)
112+
### Neovim (experimental)
113+
50114
1. Copy `neovim-mcp.json` to your Neovim MCP configuration location
51115
2. Configure according to your MCP plugin requirements
52116

53117
## Configuration Options
54118

55119
### Main Server (Recommended)
120+
56121
All templates use the unified server by default, which provides:
57-
- All parser tools (cclib, gaussian, iodata)
122+
123+
- All parser tools (`cclib`, `iodata`)
58124
- Database tools (NOMAD search/download)
59125
- Pre-built prompts for chemistry workflows
60126

61-
### Individual Servers (Testing)
62-
For testing specific parsers, you can add individual server configurations:
63-
64-
```json
65-
{
66-
"servers": {
67-
"parse-patrol": {
68-
"command": "uv",
69-
"args": ["run", "python", "-m", "parse_patrol"],
70-
"cwd": "/path/to/parse-patrol"
71-
},
72-
"parse-patrol-cclib": {
73-
"command": "uv",
74-
"args": ["run", "python", "-m", "parse_patrol.parsers.cclib"],
75-
"cwd": "/path/to/parse-patrol"
76-
},
77-
"parse-patrol-gaussian": {
78-
"command": "uv",
79-
"args": ["run", "python", "-m", "parse_patrol.parsers.gaussian"],
80-
"cwd": "/path/to/parse-patrol"
81-
},
82-
"parse-patrol-nomad": {
83-
"command": "uv",
84-
"args": ["run", "python", "-m", "parse_patrol.databases.nomad"],
85-
"cwd": "/path/to/parse-patrol"
86-
}
87-
}
88-
}
89-
```
90-
91127
## Path Configuration
92128

93129
- Replace `"${workspaceFolder}"` with the absolute path to your parse-patrol directory if needed
@@ -108,4 +144,4 @@ uv sync --extra mcp
108144
1. **"No module named 'mcp'" error**: Install MCP dependencies with `uv sync --extra mcp`
109145
2. **"No module named parse_patrol" error**: Ensure `PYTHONPATH` is set correctly in the configuration
110146
3. **Server won't start**: Check that `uv` is installed and the path is correct
111-
4. **Import errors**: Ensure you're using `uv run python -m parse_patrol` (module syntax) not direct file paths
147+
4. **Import errors**: Ensure you're using `uv run python -m parse_patrol` (module syntax) not direct file paths

0 commit comments

Comments
 (0)