Update Claude Code CLI documentation to use direct connection
- Document working CLI approach: /mcp http://localhost:4000/mcp - Remove non-working config file approach from README - Add roadmap item to research config file integration issue - Clarify that server must be running before connecting 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
27c49964fa
commit
6613b7c7f1
35
README.md
35
README.md
@ -169,39 +169,26 @@ After updating the configuration, restart Claude Desktop for the changes to take
|
|||||||
|
|
||||||
### Claude Code CLI Configuration
|
### Claude Code CLI Configuration
|
||||||
|
|
||||||
To use this MCP server with Claude Code (command line), add it to your Claude Code configuration file.
|
To use this MCP server with Claude Code (command line), use the CLI command to connect directly.
|
||||||
|
|
||||||
#### Configuration File Location
|
**IMPORTANT**: Ensure the MCP server is running before connecting (see "Starting the Server" section above).
|
||||||
|
|
||||||
- **macOS/Linux**: `~/.claude/config.json`
|
#### CLI Usage
|
||||||
- **Windows**: `%USERPROFILE%\.claude\config.json`
|
|
||||||
|
|
||||||
#### Configuration
|
Connect to the MCP server using the `/mcp` command with the server URL:
|
||||||
|
|
||||||
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
|
```bash
|
||||||
# Connect to the MCP server
|
# In Claude Code, connect to the running MCP server
|
||||||
/mcp babylon-mcp
|
/mcp http://localhost:4000/mcp
|
||||||
|
|
||||||
# Use the tools
|
# Now you can use the tools
|
||||||
Search for "Vector3" in Babylon.js documentation
|
Search for "Vector3" in Babylon.js documentation
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The `/mcp` command connects to the HTTP endpoint and makes the Babylon.js tools available in your session.
|
||||||
|
|
||||||
|
**Note**: Configuration file support for HTTP MCP servers is being investigated. Currently, use the CLI command above for the most reliable connection method.
|
||||||
|
|
||||||
## Available MCP Tools
|
## Available MCP Tools
|
||||||
|
|
||||||
Once configured, Claude will have access to these tools:
|
Once configured, Claude will have access to these tools:
|
||||||
|
|||||||
@ -51,6 +51,10 @@ Successfully implemented vector search with local embeddings:
|
|||||||
- [I] Include: CHANGELOG.md, package READMEs, contributing guides
|
- [I] Include: CHANGELOG.md, package READMEs, contributing guides
|
||||||
- [ ] Phase 2: Evaluate TypeDoc integration for API reference
|
- [ ] Phase 2: Evaluate TypeDoc integration for API reference
|
||||||
- [ ] Create documentation change detection system
|
- [ ] Create documentation change detection system
|
||||||
|
- [ ] Research and fix Claude Code config file integration issue
|
||||||
|
- CLI `/mcp http://localhost:4000/mcp` works
|
||||||
|
- Config file `~/.claude/config.json` approach does not work
|
||||||
|
- Need to investigate proper config file format for HTTP MCP servers
|
||||||
|
|
||||||
### 1.3 Search Index Implementation
|
### 1.3 Search Index Implementation
|
||||||
- [X] Design indexing strategy for markdown documentation
|
- [X] Design indexing strategy for markdown documentation
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user