Skip to content

Commit cdc81c6

Browse files
committed
docs: comprehensive documentation review and corrections
- Fix tool count from 23 to 20 (actual implementation count) - Update version from 0.2.6 to 0.3.4 (current release version) - Correct moth CLI commands: test/list to run/validate/report - Fix project name typos: CodeCodePrism to CodePrism - Remove outdated architectural references (Neo4j, Kafka, Redis) - Update GitHub repo URL from rustic-ai/ to rustic-ai/codeprism - Align all documentation with current implementation Documentation review covered: - README.md: Tool counts, architecture diagrams - docs/ARCHITECTURE.md: Project name fixes, outdated service removal - codeprism-docs/docs/mcp-server/overview.md: Version and tool count updates - crates/mandrel-mcp-th/README.md: CLI command corrections - docs/DEVELOPER.md: Service dependency removal, setup simplification All documentation now accurately reflects the current codebase state.
1 parent c10b26d commit cdc81c6

File tree

5 files changed

+38
-61
lines changed

5 files changed

+38
-61
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A production-ready, high-performance code intelligence server implementing the M
2323

2424
## 🚀 Current Status: Production Ready
2525

26-
**23 Production-Ready Tools** - 100% success rate, no failed tools
26+
**20 Production-Ready Tools** - 100% success rate, no failed tools
2727
**✅ Full MCP Compliance** - JSON-RPC 2.0 with complete protocol implementation
2828
**✅ Multi-Language Support** - JavaScript/TypeScript + Python with advanced analysis
2929
**✅ Semantic APIs** - User-friendly parameter names, no cryptic IDs required
@@ -46,7 +46,7 @@ Dragonscale Industries Inc supports the development of cutting-edge AI-powered c
4646

4747
## 🌟 Key Features
4848

49-
### **23 Advanced Analysis Tools**
49+
### **20 Advanced Analysis Tools**
5050
- **Core Navigation** (4 tools): Repository stats, symbol explanation, path tracing, dependency analysis
5151
- **Search & Discovery** (4 tools): Symbol search, content search, file finding, content statistics
5252
- **Analysis Tools** (11 tools): Complexity analysis, data flow tracing, pattern detection, inheritance analysis, security analysis, performance analysis, API surface analysis, unused code detection, duplicate detection, transitive dependencies, decorators
@@ -81,7 +81,7 @@ Dragonscale Industries Inc supports the development of cutting-edge AI-powered c
8181
8282
┌────────────┴────────────┐
8383
┌───────────────▼───────────────▼─────────────────┐
84-
23 MCP Tools │
84+
20 MCP Tools │
8585
│ ┌─────────────┐ ┌─────────────────────────┐ │
8686
│ │ Core │ │ Search & Discovery │ │
8787
│ │ Navigation │ │ 4 tools │ │
@@ -338,7 +338,7 @@ Your support helps us:
338338
- **Query Speed**: Sub-millisecond for most symbol and content searches
339339

340340
**Test Coverage:**
341-
- **23/23 tools working** (100% success rate)
341+
- **20/20 tools working** (100% success rate)
342342
- **425 comprehensive tests** across all crates and parser debugging tools
343343
- **Comprehensive testing** against real-world repositories
344344
- **Full MCP protocol compliance** verified

codeprism-docs/docs/mcp-server/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ CodePrism provides a **production-ready MCP server** that enables AI assistants
1414

1515
### 🔌 **Complete MCP Compliance**
1616
- **Resources**: Repository files, code symbols, and graph data
17-
- **Tools**: 23 production-ready code analysis and navigation tools
17+
- **Tools**: 20 production-ready code analysis and navigation tools
1818
- **Prompts**: Code analysis templates and workflow guidance
1919
- **Real-time Updates**: Live resource and tool updates
2020

2121
### 🚀 **Production-Ready Capabilities**
22-
- **100% Tool Success Rate** - All 23 tools tested and production-ready
22+
- **100% Tool Success Rate** - All 20 tools tested and production-ready
2323
- **Semantic Parameter Support** - Human-readable names instead of cryptic IDs
2424
- **Environment Variable Integration** - Automatic repository detection
2525
- **Context-Enhanced Responses** - Source code snippets included
@@ -30,7 +30,7 @@ CodePrism provides a **production-ready MCP server** that enables AI assistants
3030
```json
3131
{
3232
"name": "codeprism-mcp-server",
33-
"version": "0.2.6",
33+
"version": "0.3.4",
3434
"capabilities": {
3535
"resources": {
3636
"subscribe": true,
@@ -74,7 +74,7 @@ CodePrism provides a **production-ready MCP server** that enables AI assistants
7474
- `codeprism://architecture/patterns` - Detected design patterns and structures
7575
- `codeprism://architecture/dependencies` - High-level dependency analysis
7676

77-
## Production Tools (23 Available)
77+
## Production Tools (20 Available)
7878

7979
### Core Navigation & Understanding (4 tools)
8080
1. **`repository_stats`** - Get comprehensive statistics about the repository

crates/mandrel-mcp-th/README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ moth --version
3131

3232
```bash
3333
# Run tests from a specification file
34-
moth test my-server.yaml
34+
moth run my-server.yaml
3535

3636
# Validate a test specification
3737
moth validate my-server.yaml
3838

39-
# List available tests
40-
moth list my-server.yaml --detailed
39+
# Generate reports from test results
40+
moth report --format html --output results.html
4141

4242
# Show version information
43-
moth version
43+
moth --version
4444
```
4545

4646
### Test Specification Example
@@ -94,19 +94,16 @@ tools:
9494

9595
## CLI Commands
9696

97-
### `moth test`
97+
### `moth run`
9898

9999
Run test specifications against MCP servers.
100100

101101
```bash
102-
moth test [OPTIONS] <SPEC>
102+
moth run [OPTIONS] <SPEC>
103103

104104
Options:
105-
-o, --output-file <FILE> Output file for test results
106-
-f, --fail-fast Stop execution on first failure
107-
-F, --filter <PATTERN> Test filter pattern
108-
-c, --concurrency <N> Maximum concurrent tests [default: 4]
109-
--output <FORMAT> Output format [default: json] [possible: json, html, junit, text]
105+
--output <DIR> Output directory for test results
106+
--formats <FORMAT> Output formats (json, html, junit)
110107
```
111108

112109
### `moth validate`
@@ -117,15 +114,16 @@ Validate test specification syntax and structure.
117114
moth validate <SPEC>
118115
```
119116

120-
### `moth list`
117+
### `moth report`
121118

122-
List available tests in a specification.
119+
Generate reports from test execution results.
123120

124121
```bash
125-
moth list [OPTIONS] <SPEC>
122+
moth report [OPTIONS]
126123

127124
Options:
128-
-d, --detailed Show detailed test information
125+
--format <FORMAT> Report format (json, html, junit)
126+
--output <FILE> Output file path
129127
```
130128

131129
## Library Usage

docs/ARCHITECTURE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Architecture Guide
22

3-
This document describes the high-level architecture, design decisions, and implementation details of CodeCodePrism.
3+
This document describes the high-level architecture, design decisions, and implementation details of CodePrism.
44

55
**🚨 ARCHITECTURAL PIVOT - December 2024**
66

@@ -19,13 +19,13 @@ After detailed review against official MCP (Model Context Protocol) documentatio
1919

2020
## System Overview
2121

22-
CodeCodePrism is a **MCP-compliant** graph-first code intelligence system designed to provide real-time, accurate code understanding for LLM assistants. The system implements the Model Context Protocol (JSON-RPC 2.0) specification to integrate seamlessly with MCP clients like Claude Desktop, Cursor, and VS Code GitHub Copilot.
22+
CodePrism is a **MCP-compliant** graph-first code intelligence system designed to provide real-time, accurate code understanding for LLM assistants. The system implements the Model Context Protocol (JSON-RPC 2.0) specification to integrate seamlessly with MCP clients like Claude Desktop, Cursor, and VS Code GitHub Copilot.
2323

2424
### **MCP-Optimized Architecture**
2525

2626
```
2727
┌─────────────────────────────────────────────────────────────┐
28-
│ MCP-Compliant CodeCodePrism
28+
│ MCP-Compliant CodePrism
2929
├─────────────────────────────────────────────────────────────┤
3030
│ MCP Clients │
3131
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
@@ -36,7 +36,7 @@ CodeCodePrism is a **MCP-compliant** graph-first code intelligence system design
3636
│ └───────────────┼───────────────┘ │
3737
│ ▼ (JSON-RPC 2.0) │
3838
│ ┌─────────────────────────────────────────────────────────┐ │
39-
│ │ CodeCodePrism MCP Server │ │
39+
│ │ CodePrism MCP Server │ │
4040
│ │ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │ │
4141
│ │ │ Resources │ │ Tools │ │ Prompts │ │ │
4242
│ │ │ Manager │ │ Manager │ │ Manager │ │ │
@@ -86,7 +86,7 @@ CodeCodePrism is a **MCP-compliant** graph-first code intelligence system design
8686

8787
### 1. **MCP Protocol Compliance**
8888

89-
CodeCodePrism strictly adheres to the Model Context Protocol specification:
89+
CodePrism strictly adheres to the Model Context Protocol specification:
9090

9191
- **JSON-RPC 2.0**: All communication uses proper JSON-RPC 2.0 format
9292
- **Initialization Handshake**: Proper capability negotiation
@@ -103,7 +103,7 @@ Based on MCP best practices:
103103

104104
### 3. **Graph-First Design**
105105

106-
Maintains the core strength of CodeCodePrism:
106+
Maintains the core strength of CodePrism:
107107
- **Structural Understanding**: Relationships between functions, classes, and modules
108108
- **Cross-Language Analysis**: Unified representation across programming languages
109109
- **Efficient Queries**: Graph traversal for code navigation and analysis
@@ -614,7 +614,7 @@ pub struct HealthStatus {
614614

615615
## Conclusion
616616

617-
This **MCP-compliant architecture** provides a robust, performant, and standards-compliant foundation for CodeCodePrism that:
617+
This **MCP-compliant architecture** provides a robust, performant, and standards-compliant foundation for CodePrism that:
618618

619619
1. **Meets MCP Requirements**: Full JSON-RPC 2.0 compliance with proper transport
620620
2. **Optimizes for Simplicity**: Removed unnecessary complexity for better performance

docs/DEVELOPER.md

Lines changed: 10 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Developer Guide
22

3-
This guide covers the development workflow, architecture, and best practices for contributing to CodeCodePrism.
3+
This guide covers the development workflow, architecture, and best practices for contributing to CodePrism.
44

55
## Table of Contents
66

@@ -19,15 +19,14 @@ This guide covers the development workflow, architecture, and best practices for
1919
### Prerequisites
2020

2121
- **Rust**: 1.82+ with `rustfmt` and `clippy`
22-
- **Docker**: For development services (Neo4j, Kafka)
2322
- **Make**: For build automation
2423
- **Git**: Version control
2524

2625
### Initial Setup
2726

2827
```bash
2928
# Clone the repository
30-
git clone https://github.com/rustic-ai /codeprism
29+
git clone https://github.com/rustic-ai/codeprism
3130
cd codeprism
3231

3332
# Install Rust toolchain components
@@ -38,41 +37,21 @@ cargo install cargo-tarpaulin # Code coverage
3837
cargo install cargo-watch # File watching
3938
cargo install cargo-expand # Macro expansion
4039

41-
# Start development services
42-
make dev-up
40+
# Build the project
41+
cargo build --release
4342

4443
# Verify setup
4544
make check
4645
```
4746

48-
### Development Services
47+
### Development Environment
4948

50-
The project uses Docker Compose for development dependencies:
49+
CodePrism uses a simplified in-memory architecture without external services:
5150

52-
```yaml
53-
# docker-compose.yml
54-
services:
55-
neo4j:
56-
image: neo4j:5.15
57-
ports: ["7474:7474", "7687:7687"]
58-
environment:
59-
NEO4J_AUTH: neo4j/password
60-
61-
kafka:
62-
image: confluentinc/cp-kafka:latest
63-
ports: ["9092:9092"]
64-
65-
redis:
66-
image: redis:7-alpine
67-
ports: ["6379:6379"]
68-
```
69-
70-
Start services:
71-
```bash
72-
make dev-up # Start all services
73-
make dev-down # Stop all services
74-
make dev-logs # View service logs
75-
```
51+
- **In-Memory Graph Store**: Fast local graph storage using DashMap
52+
- **File System Watcher**: Real-time file change detection
53+
- **MCP Protocol**: JSON-RPC 2.0 over stdio transport
54+
- **Optional Persistence**: File-based caching for faster startup
7655

7756
## Project Structure
7857

0 commit comments

Comments
 (0)