Skip to content

Commit cc9b72b

Browse files
committed
Docs: Add deprecation notice for MCP FAISS+RocksDB architecture
Updated CHANGELOG.md and README.md to clearly communicate the architectural shift from FAISS+RocksDB to SurrealDB for MCP server code-agent functionality. ## CHANGELOG.md Updates: ### Added - Unreleased Section: - Complete documentation of 7 new agentic MCP tools - Tier-aware orchestration details (Small/Medium/Large/Massive) - 28 specialized prompts (7 analysis types × 4 tiers) - Graph analysis integration with 6 SurrealDB tools - New CLI command: codegraph config agent-status ### Deprecated Section: - Clear statement: MCP server FAISS+RocksDB support deprecated - What remains supported: CLI, SDK, NAPI bindings - Migration path: SurrealDB setup instructions - Free cloud services highlighted: * SurrealDB Cloud: 1GB free instance * Jina AI: 10 million free tokens - Rationale for change explained ## README.md Updates: ### New Section: Important Notice - Prominent warning about MCP server architecture change - Clear breakdown of what changed vs. what remains - Setup requirements for code-agent tools - Two installation options (cloud vs. local) - Free resource highlights for both SurrealDB and Jina AI - Rationale for architectural shift - Link to CHANGELOG.md for detailed migration guide ### Updated Feature List: - Added: Agentic code-agent tools with tier-aware reasoning ## Key Messages: 1. **MCP server** deprecates FAISS+RocksDB 2. **CLI/SDK/NAPI** continue to support FAISS+RocksDB 3. **Code-agent tools** require SurrealDB (local or cloud) 4. **Free options available**: 1GB SurrealDB + 10M Jina tokens 5. **Migration is straightforward**: Clear setup instructions provided This ensures users understand: - The architectural change and its scope - What continues to work unchanged - How to set up new requirements - Access to free cloud resources - The technical reasoning behind the change
1 parent 6b6a2a1 commit cc9b72b

File tree

2 files changed

+154
-12
lines changed

2 files changed

+154
-12
lines changed

CHANGELOG.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,105 @@ All notable changes to the CodeGraph MCP Intelligence Platform will be documente
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [Unreleased] - 2025-01-08 - Agentic Code Intelligence & Architecture Migration
9+
10+
### 🚀 **Added - Agentic MCP Tools (AI-Enhanced Feature)**
11+
12+
#### **1. Tier-Aware Agentic Orchestration**
13+
- **7 Agentic MCP Tools**: Multi-step reasoning workflows for comprehensive code analysis
14+
- `agentic_code_search` - Autonomous graph exploration for code search
15+
- `agentic_dependency_analysis` - Dependency chain and impact analysis
16+
- `agentic_call_chain_analysis` - Execution flow tracing
17+
- `agentic_architecture_analysis` - Architectural pattern assessment
18+
- `agentic_api_surface_analysis` - Public interface analysis
19+
- `agentic_context_builder` - Comprehensive context gathering
20+
- `agentic_semantic_question` - Complex codebase Q&A
21+
- **Automatic tier detection**: Based on LLM context window (Small/Medium/Large/Massive)
22+
- **Tier-aware prompting**: 28 specialized prompts (7 types × 4 tiers)
23+
- Small (<50K): TERSE prompts, 5 max steps, 2,048 tokens
24+
- Medium (50K-150K): BALANCED prompts, 10 max steps, 4,096 tokens
25+
- Large (150K-500K): DETAILED prompts, 15 max steps, 8,192 tokens
26+
- Massive (>500K): EXPLORATORY prompts, 20 max steps, 16,384 tokens
27+
- **LRU caching**: Transparent SurrealDB result caching (100 entries default)
28+
- **Configurable max tokens**: `MCP_CODE_AGENT_MAX_OUTPUT_TOKENS` env variable
29+
30+
#### **2. Graph Analysis Integration**
31+
- **6 SurrealDB graph tools**: Deep structural code analysis
32+
- `get_transitive_dependencies` - Full dependency chains
33+
- `detect_circular_dependencies` - Cycle detection
34+
- `trace_call_chain` - Execution path analysis
35+
- `calculate_coupling_metrics` - Ca, Ce, I metrics
36+
- `get_hub_nodes` - Architectural hotspot detection
37+
- `get_reverse_dependencies` - Change impact assessment
38+
- **Zero-heuristic design**: LLM infers from structured data only
39+
- **Tool call logging**: Complete reasoning traces with execution stats
40+
- **Cache statistics**: Hit rate, evictions, size tracking
41+
42+
#### **3. CLI Enhancements**
43+
- **New command**: `codegraph config agent-status`
44+
- Shows LLM provider, context tier, prompt verbosity
45+
- Lists all available MCP tools with descriptions
46+
- Displays orchestrator settings (max steps, cache, tokens)
47+
- JSON output support for automation
48+
- **Configuration visibility**: Understand how config affects system behavior
49+
50+
### ⚠️ **Deprecated - MCP Server FAISS+RocksDB Support**
51+
52+
**IMPORTANT**: The MCP server's FAISS+RocksDB graph database solution is now **deprecated** in favor of SurrealDB-based architecture.
53+
54+
**What's Deprecated:**
55+
- MCP server integration with FAISS vector search
56+
- MCP server integration with RocksDB graph storage
57+
- Cloud dual-mode search via MCP protocol
58+
59+
**What Remains Supported:**
60+
-**CLI commands**: All FAISS/RocksDB operations remain available via `codegraph` CLI
61+
-**Rust SDK**: Full programmatic access to FAISS/RocksDB functionality
62+
-**NAPI bindings**: TypeScript/Node.js integration still functional
63+
-**Local embeddings**: ONNX, Ollama, LM Studio providers unchanged
64+
65+
**Migration Path:**
66+
67+
For **MCP code-agent** functionality, you must now set up SurrealDB:
68+
69+
**Option 1: Free Cloud Instance (Recommended for testing)**
70+
1. Sign up at [Surreal Cloud](https://surrealdb.com/cloud) - **FREE 1GB instance included**
71+
2. Get connection details from dashboard
72+
3. Configure environment:
73+
```bash
74+
export SURREALDB_URL=wss://your-instance.surrealdb.cloud
75+
export SURREALDB_NAMESPACE=codegraph
76+
export SURREALDB_DATABASE=main
77+
export SURREALDB_USERNAME=your-username
78+
export SURREALDB_PASSWORD=your-password
79+
```
80+
81+
**Option 2: Local Installation**
82+
```bash
83+
# Install SurrealDB
84+
curl -sSf https://install.surrealdb.com | sh
85+
86+
# Run locally
87+
surreal start --bind 127.0.0.1:3004 --user root --pass root memory
88+
89+
# Configure
90+
export SURREALDB_URL=ws://localhost:3004
91+
export SURREALDB_NAMESPACE=codegraph
92+
export SURREALDB_DATABASE=main
93+
```
94+
95+
**Free Cloud Services:**
96+
- 🆓 **SurrealDB Cloud**: 1GB free instance (perfect for testing and small projects)
97+
- 🆓 **Jina AI**: 10 million free API tokens when you register at [jina.ai](https://jina.ai)
98+
- Includes embeddings, reranking, and token counting APIs
99+
- Production-grade embeddings with no local GPU required
100+
101+
**Rationale:**
102+
- SurrealDB provides native graph capabilities vs. custom RocksDB layer
103+
- HNSW vector indexing is built-in vs. separate FAISS integration
104+
- Cloud-native architecture enables distributed deployments
105+
- Unified storage reduces complexity and maintenance overhead
106+
8107
## [1.1.0] - 2025-11-08 - Cloud-Native Vector Search & TypeScript Integration
9108

10109
### 🌟 **Major Release - Cloud Embeddings, Dual-Mode Search, and NAPI Bindings**

README.md

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,49 @@ CodeGraph indexes your source code, creates semantic embeddings, and exposes a *
1414
- ☁️ **NEW:** Jina AI cloud embeddings with modifiable models and dimensions and reranking
1515
- 🗄️ **NEW:** SurrealDB HNSW backend for cloud-native and local vector search
1616
- 📦 **NEW:** Node.js NAPI bindings for zero-overhead TypeScript integration
17+
- 🤖 **NEW:** Agentic code-agent tools with tier-aware multi-step reasoning
18+
19+
---
20+
21+
## ⚠️ Important: MCP Server Architecture Change
22+
23+
**FAISS+RocksDB support in MCP server is deprecated** in favor of SurrealDB-based architecture.
24+
25+
### What Changed:
26+
-**MCP server** no longer uses FAISS vector search or RocksDB graph storage
27+
-**CLI and SDK** continue to support FAISS/RocksDB for local operations
28+
-**NAPI bindings** still provide TypeScript access to all features
29+
- 🆕 **MCP code-agent tools** now require SurrealDB for graph analysis
30+
31+
### Required Setup for Code-Agent Tools:
32+
33+
The new agentic MCP tools (`agentic_code_search`, `agentic_dependency_analysis`, etc.) require SurrealDB:
34+
35+
**Option 1: Free Cloud Instance (Recommended)**
36+
- Sign up at [Surreal Cloud](https://surrealdb.com/cloud)
37+
- **Get 1GB FREE instance** - perfect for testing and small projects
38+
- Configure connection details in environment variables
39+
40+
**Option 2: Local Installation**
41+
```bash
42+
# Install SurrealDB
43+
curl -sSf https://install.surrealdb.com | sh
44+
45+
# Run locally
46+
surreal start --bind 127.0.0.1:3004 --user root --pass root memory
47+
```
48+
49+
**Free Cloud Resources:**
50+
- 🆓 **SurrealDB Cloud**: 1GB free instance at [surrealdb.com/cloud](https://surrealdb.com/cloud)
51+
- 🆓 **Jina AI**: 10 million free API tokens at [jina.ai](https://jina.ai) for embeddings and reranking
52+
53+
### Why This Change:
54+
- **Native graph capabilities**: SurrealDB provides built-in graph database features
55+
- **Unified storage**: Single database for both vectors and graph relationships
56+
- **Cloud-native**: Better support for distributed deployments
57+
- **Reduced complexity**: Eliminates custom RocksDB integration layer
58+
59+
**See [CHANGELOG.md](CHANGELOG.md) for detailed migration guide.**
1760

1861
---
1962

@@ -179,7 +222,7 @@ ollama_url = "http://localhost:11434"
179222
- Install and launch the app
180223

181224
**Step 2: Download models in LM Studio**
182-
- **Embedding model:** `jinaai/jina-code-embeddings-1.5b`
225+
- **Embedding model:** `jinaai/jina-embeddings-v4`
183226
- **LLM model (optional):** `lmstudio-community/DeepSeek-Coder-V2-Lite-Instruct-GGUF`
184227

185228
**Step 3: Start LM Studio server**
@@ -200,9 +243,9 @@ Create `~/.codegraph/config.toml`:
200243
```toml
201244
[embedding]
202245
provider = "lmstudio"
203-
model = "jinaai/jina-code-embeddings-1.5b"
246+
model = "jinaai/jina-embeddings-v4"
204247
lmstudio_url = "http://localhost:1234"
205-
dimension = 1536
248+
dimension = 2048
206249

207250
[llm]
208251
enabled = true
@@ -260,9 +303,9 @@ The wizard will guide you through configuration.
260303
```toml
261304
[embedding]
262305
provider = "jina" # or openai
263-
model = "jina-code-embeddings-1.5b"
306+
model = "jina-embeddings-v4"
264307
openai_api_key = "sk-..." # or set OPENAI_API_KEY env var
265-
dimension = 1536
308+
dimension = 2048
266309

267310
[llm]
268311
enabled = true
@@ -276,9 +319,9 @@ context_window = 200000
276319
```toml
277320
[embedding]
278321
provider = "jina" # or openai
279-
model = "jina-code-embeddings-1.5b"
322+
model = "jina-embeddings-v4"
280323
openai_api_key = "sk-..."
281-
dimension = 1536
324+
dimension = 2048
282325

283326
[llm]
284327
enabled = true
@@ -312,7 +355,7 @@ anthropic_api_key = "sk-ant-..."
312355
provider = "openai" # or "jina"
313356
model = "text-embedding-3-small"
314357
openai_api_key = "sk-..."
315-
dimension = 1536
358+
dimension = 2048
316359

317360
[llm]
318361
enabled = true
@@ -328,9 +371,9 @@ context_window = 2000000 # 2M tokens!
328371
```toml
329372
[embedding]
330373
provider = "jina" # or "openai"
331-
model = "jina-code-embeddings-1.5b"
374+
model = "jina-embeddings-v4"
332375
openai_api_key = "sk-..."
333-
dimension = 1536
376+
dimension = 2048
334377

335378
[vector_store]
336379
backend = "surrealdb" # Instead of "faiss"
@@ -411,8 +454,8 @@ Configuration is loaded from (in order):
411454
```toml
412455
[embedding]
413456
provider = "lmstudio" # or "onnx", "ollama", "openai"
414-
model = "jinaai/jina-code-embeddings-1.5b"
415-
dimension = 1536
457+
model = "jinaai/jina-embeddings-v4"
458+
dimension = 2048
416459
batch_size = 64
417460

418461
[llm]

0 commit comments

Comments
 (0)