Skip to content

Commit 2fcb5fa

Browse files
committed
docs: standardize on codegraph-official binary for consistency
1 parent 89cdffd commit 2fcb5fa

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

CLAUDE.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,27 @@ cargo doc --workspace --no-deps --open
9292

9393
### Running the MCP Server
9494

95+
**Note:** The MCP server has two binaries:
96+
- `codegraph-official` (recommended): Uses official rmcp SDK, supports both STDIO and HTTP transports
97+
- `codegraph` (legacy): Original implementation, STDIO only
98+
99+
All examples below use `codegraph-official` for consistency.
100+
95101
```bash
96102
# Build the MCP server binary (with AutoAgents experimental feature)
97-
cargo build --release -p codegraph-mcp --bin codegraph --features "ai-enhanced,autoagents-experimental,faiss,ollama"
103+
cargo build --release -p codegraph-mcp --bin codegraph-official --features "ai-enhanced,autoagents-experimental,faiss,ollama"
98104

99105
# Or use Makefile target
100106
make build-mcp-autoagents
101107

102108
# Or build without AutoAgents (uses legacy orchestrator)
103-
cargo build --release -p codegraph-mcp --bin codegraph --features "ai-enhanced,faiss,ollama"
109+
cargo build --release -p codegraph-mcp --bin codegraph-official --features "ai-enhanced,faiss,ollama"
104110

105111
# Start MCP server (stdio mode - RECOMMENDED)
106-
./target/release/codegraph start stdio
112+
./target/release/codegraph-official serve --transport stdio
107113

108114
# Check agentic tool configuration
109-
./target/release/codegraph config agent-status
115+
./target/release/codegraph-official config agent-status
110116
```
111117

112118
**HTTP Transport (Experimental):**
@@ -477,9 +483,9 @@ sudo apt-get install libfaiss-dev # Ubuntu
477483
- Verify SurrealDB connection is working
478484

479485
**MCP tests fail**
480-
- Check binary exists: `./target/release/codegraph` or `./target/debug/codegraph`
481-
- Try building with AutoAgents: `cargo build -p codegraph-mcp --bin codegraph --features "ai-enhanced,autoagents-experimental,faiss,ollama"`
482-
- Or without AutoAgents (legacy): `cargo build -p codegraph-mcp --bin codegraph --features "ai-enhanced,faiss,ollama"`
486+
- Check binary exists: `./target/release/codegraph-official` or `./target/debug/codegraph-official`
487+
- Try building with AutoAgents: `cargo build -p codegraph-mcp --bin codegraph-official --features "ai-enhanced,autoagents-experimental,faiss,ollama"`
488+
- Or without AutoAgents (legacy): `cargo build -p codegraph-mcp --bin codegraph-official --features "ai-enhanced,faiss,ollama"`
483489

484490
## Additional Resources
485491

0 commit comments

Comments
 (0)