From 210ceb7d2456ed67301f5451c61fed217e15ffc3 Mon Sep 17 00:00:00 2001 From: Michael Mainguy Date: Sun, 23 Nov 2025 07:36:10 -0600 Subject: [PATCH] Update README with correct HTTP transport configuration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updated integration instructions to reflect HTTP transport architecture: - Clarified that server must be running before connecting clients - Changed from command-based to URL-based configuration - Added Claude Code CLI configuration section (~/.claude/config.json) - Added Linux config file location - Updated troubleshooting to emphasize server must be running - Added health check verification step Configuration now uses: - Claude Desktop: ~/Library/Application Support/Claude/claude_desktop_config.json - Claude Code CLI: ~/.claude/config.json - URL format: http://localhost:4000/mcp 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 84 +++++++++++++++++++++++------ examples/audioEngine/with_mcp.md | 0 examples/audioEngine/without_mcp.md | 0 3 files changed, 67 insertions(+), 17 deletions(-) create mode 100644 examples/audioEngine/with_mcp.md create mode 100644 examples/audioEngine/without_mcp.md diff --git a/README.md b/README.md index 5e7b6c7..de42af4 100644 --- a/README.md +++ b/README.md @@ -97,16 +97,35 @@ npm start The server runs on **port 4000** by default. -## Integration with Claude Desktop +## Integration with AI Assistants + +The Babylon MCP server uses HTTP transport and must be running before connecting AI assistants. + +### Starting the Server + +First, start the MCP server: + +```bash +# Development mode with hot reload +npm run dev + +# OR production mode +npm start +``` + +The server runs on **http://localhost:4000** by default. + +### Claude Desktop Configuration To use this MCP server with Claude Desktop, add it to your Claude configuration file. -### Configuration File Location +#### Configuration File Location -**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` -**Windows**: `%APPDATA%\Claude\claude_desktop_config.json` +- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` +- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json` +- **Linux**: `~/.config/Claude/claude_desktop_config.json` -### Configuration +#### Configuration Add the following to your `claude_desktop_config.json`: @@ -114,22 +133,51 @@ Add the following to your `claude_desktop_config.json`: { "mcpServers": { "babylon-mcp": { - "command": "node", - "args": [ - "/absolute/path/to/babylon-mcp/dist/mcp/index.js" - ], - "env": {} + "url": "http://localhost:4000/mcp" } } } ``` -Replace `/absolute/path/to/babylon-mcp` with the actual path to your babylon-mcp directory. - -### Restart Claude Desktop +#### Restart Claude Desktop After updating the configuration, restart Claude Desktop for the changes to take effect. +### Claude Code CLI Configuration + +To use this MCP server with Claude Code (command line), add it to your Claude Code configuration file. + +#### Configuration File Location + +- **macOS/Linux**: `~/.claude/config.json` +- **Windows**: `%USERPROFILE%\.claude\config.json` + +#### Configuration + +Add the following to your `config.json`: + +```json +{ + "mcpServers": { + "babylon-mcp": { + "url": "http://localhost:4000/mcp" + } + } +} +``` + +#### Usage + +After configuration, you can use the `/mcp` command in Claude Code to interact with the server: + +```bash +# Connect to the MCP server +/mcp babylon-mcp + +# Use the tools +Search for "Vector3" in Babylon.js documentation +``` + ## Available MCP Tools Once configured, Claude will have access to these tools: @@ -284,10 +332,12 @@ npm run index:all - Check disk space (~2GB required) - Try indexing components individually to isolate the issue -### Claude Desktop doesn't see the tools -- Verify the path in `claude_desktop_config.json` is absolute -- Restart Claude Desktop after configuration changes -- Check that the server builds without errors: `npm run build` +### Claude doesn't see the tools +- **Ensure the server is running**: `npm run dev` or `npm start` +- **Verify server is accessible**: `curl http://localhost:4000/health` should return `{"status":"healthy"...}` +- **Check configuration**: Ensure `~/.claude/config.json` or Claude Desktop config has the correct URL +- **Restart Claude**: Restart Claude Desktop or Claude Code after configuration changes +- **Check server logs**: Look for connection attempts in the server output ### Search returns no results - Ensure indexing has completed successfully diff --git a/examples/audioEngine/with_mcp.md b/examples/audioEngine/with_mcp.md new file mode 100644 index 0000000..e69de29 diff --git a/examples/audioEngine/without_mcp.md b/examples/audioEngine/without_mcp.md new file mode 100644 index 0000000..e69de29