Skip to content

Commit 24f5f16

Browse files
committed
docs: add Cline and Claude Code configuration
Add setup instructions for Cline and Claude Code MCP clients. Include configuration examples and OS-specific paths. Fixes #6
1 parent 0c451a4 commit 24f5f16

File tree

1 file changed

+73
-3
lines changed

1 file changed

+73
-3
lines changed

README.md

Lines changed: 73 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,13 @@ https://github.com/user-attachments/assets/75f0c176-6da1-48dc-ad96-c182eb4648c3
139139
140140
## MCP Clients
141141
142-
Theoretically, any MCP client should work with GhydraMCP. Two examples are given below.
142+
GhydraMCP works with any MCP-compatible client using **stdio transport**. It has been tested and confirmed working with:
143+
144+
- **Claude Desktop** - Anthropic's official desktop application
145+
- **Claude Code** - Anthropic's VS Code extension and CLI tool
146+
- **Cline** - Popular VS Code extension for AI-assisted coding
147+
148+
See the [Client Setup](#client-setup) section below for detailed configuration instructions for each client.
143149
144150
## API Reference (Updated for v2.0)
145151
@@ -218,7 +224,12 @@ client.use_tool("ghydra", "register_instance", {"port": 8193})
218224
219225
## Client Setup
220226

227+
GhydraMCP works with any MCP-compatible client. Below are configuration examples for popular AI coding assistants.
228+
221229
### Claude Desktop Configuration
230+
231+
Add this to your Claude Desktop configuration file (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS, `%APPDATA%\Claude\claude_desktop_config.json` on Windows):
232+
222233
```json
223234
{
224235
"mcpServers": {
@@ -229,7 +240,7 @@ client.use_tool("ghydra", "register_instance", {"port": 8193})
229240
"/ABSOLUTE_PATH_TO/bridge_mcp_hydra.py"
230241
],
231242
"env": {
232-
"GHIDRA_HYDRA_HOST": "localhost" // Optional - defaults to localhost
243+
"GHIDRA_HYDRA_HOST": "localhost"
233244
}
234245
}
235246
}
@@ -238,8 +249,67 @@ client.use_tool("ghydra", "register_instance", {"port": 8193})
238249

239250
> **Note:** You can also use `python` instead of `uv run`, but then you'll need to manually install the requirements first with `pip install mcp requests`.
240251
252+
### Claude Code Configuration
253+
254+
Claude Code automatically discovers MCP servers configured in Claude Desktop. If you've set up the configuration above, Claude Code will have access to GhydraMCP tools immediately.
255+
256+
Alternatively, you can configure Claude Code separately by adding the same configuration to the MCP settings in Claude Code's configuration.
257+
258+
### Cline Configuration
259+
260+
Cline (VS Code extension) uses a separate configuration file. To set up GhydraMCP with Cline:
261+
262+
1. Open VS Code with Cline installed
263+
2. Click the "MCP Servers" icon in Cline's interface
264+
3. Select the "Configure" tab
265+
4. Click "Configure MCP Servers" to edit `cline_mcp_settings.json`
266+
5. Add the following configuration:
267+
268+
```json
269+
{
270+
"mcpServers": {
271+
"ghydra": {
272+
"command": "uv",
273+
"args": [
274+
"run",
275+
"/ABSOLUTE_PATH_TO/bridge_mcp_hydra.py"
276+
],
277+
"env": {
278+
"GHIDRA_HYDRA_HOST": "localhost"
279+
},
280+
"disabled": false
281+
}
282+
}
283+
}
284+
```
285+
286+
If you prefer to use `python` directly instead of `uv`:
287+
288+
```json
289+
{
290+
"mcpServers": {
291+
"ghydra": {
292+
"command": "python",
293+
"args": [
294+
"/ABSOLUTE_PATH_TO/bridge_mcp_hydra.py"
295+
],
296+
"env": {
297+
"GHIDRA_HYDRA_HOST": "localhost"
298+
},
299+
"disabled": false
300+
}
301+
}
302+
}
303+
```
304+
305+
> **Important:** Replace `/ABSOLUTE_PATH_TO/` with the actual absolute path to your `bridge_mcp_hydra.py` file. For example:
306+
> - **Linux/macOS**: `/home/username/GhydraMCP/bridge_mcp_hydra.py`
307+
> - **Windows**: `C:\\Users\\username\\GhydraMCP\\bridge_mcp_hydra.py`
308+
309+
After saving the configuration, restart Cline to load the GhydraMCP server.
310+
241311
### 5ire Configuration
242-
1. Tool Key: ghydra
312+
1. Tool Key: ghydra
243313
2. Name: GhydraMCP
244314
3. Command: `uv run /ABSOLUTE_PATH_TO/bridge_mcp_hydra.py`
245315

0 commit comments

Comments
 (0)