@giauphan/codeatlas-mcp 1.2.2 β 1.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -35
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,76 +1,106 @@
|
|
|
1
1
|
# πΊοΈ CodeAtlas MCP Server
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@giauphan/codeatlas-mcp)
|
|
5
4
|
|
|
6
5
|
|
|
6
|
+
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
A standalone [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that reads CodeAtlas analysis data and exposes it to AI assistants like **Gemini, Claude, Cursor**, etc.
|
|
8
|
+
> A standalone [MCP](https://modelcontextprotocol.io/) server that exposes [CodeAtlas](https://github.com/giauphan/CodeAtlas) analysis data to AI assistants β **Gemini, Claude, Cursor, Windsurf**, and more.
|
|
11
9
|
|
|
12
|
-
|
|
10
|
+
---
|
|
13
11
|
|
|
14
|
-
|
|
15
|
-
|------|-------------|
|
|
16
|
-
| `list_projects` | List all projects analyzed by CodeAtlas |
|
|
17
|
-
| `get_project_structure` | Get modules, classes, functions, variables |
|
|
18
|
-
| `get_dependencies` | Get import/call/containment relationships |
|
|
19
|
-
| `get_insights` | Get AI-generated code insights |
|
|
20
|
-
| `search_entities` | Search for functions, classes by name |
|
|
21
|
-
| `get_file_entities` | Get all entities in a specific file |
|
|
12
|
+
## β‘ Quick Start
|
|
22
13
|
|
|
23
|
-
|
|
14
|
+
### 1. Analyze your project
|
|
24
15
|
|
|
25
|
-
|
|
26
|
-
2. Run **CodeAtlas: Analyze Project** in VS Code to generate `.codeatlas/analysis.json`
|
|
16
|
+
Install the [CodeAtlas VS Code extension](https://github.com/giauphan/CodeAtlas), then run:
|
|
27
17
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
git clone https://github.com/giauphan/codeatlas-mcp.git
|
|
32
|
-
cd codeatlas-mcp
|
|
33
|
-
npm install
|
|
34
|
-
npm run build
|
|
18
|
+
```
|
|
19
|
+
Ctrl+Shift+P β CodeAtlas: Analyze Project
|
|
35
20
|
```
|
|
36
21
|
|
|
37
|
-
|
|
22
|
+
This generates `.codeatlas/analysis.json` in your project root.
|
|
38
23
|
|
|
39
|
-
|
|
24
|
+
### 2. Add MCP config
|
|
40
25
|
|
|
41
|
-
|
|
26
|
+
Copy the JSON block below into **one** of these files depending on your AI assistant:
|
|
27
|
+
|
|
28
|
+
| AI Assistant | Config file |
|
|
29
|
+
|---|---|
|
|
30
|
+
| **Gemini** | `.gemini/settings.json` |
|
|
31
|
+
| **Claude Desktop** | `claude_desktop_config.json` |
|
|
32
|
+
| **Cursor** | `.cursor/mcp.json` |
|
|
33
|
+
| **Windsurf** | `.windsurf/mcp.json` |
|
|
42
34
|
|
|
43
35
|
```json
|
|
44
36
|
{
|
|
45
37
|
"mcpServers": {
|
|
46
38
|
"codeatlas": {
|
|
47
|
-
"command": "
|
|
48
|
-
"args": ["/
|
|
39
|
+
"command": "npx",
|
|
40
|
+
"args": ["-y", "@giauphan/codeatlas-mcp"]
|
|
49
41
|
}
|
|
50
42
|
}
|
|
51
43
|
}
|
|
52
44
|
```
|
|
53
45
|
|
|
54
|
-
|
|
46
|
+
> **That's it!** Your AI assistant can now query your codebase structure, dependencies, and insights.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## π οΈ Available Tools
|
|
51
|
+
|
|
52
|
+
| Tool | Description |
|
|
53
|
+
|------|-------------|
|
|
54
|
+
| `list_projects` | List all analyzed projects (auto-discovers `~/`) |
|
|
55
|
+
| `get_project_structure` | Get modules, classes, functions, variables |
|
|
56
|
+
| `get_dependencies` | Get import / call / containment relationships |
|
|
57
|
+
| `get_insights` | Get AI-generated code quality insights |
|
|
58
|
+
| `search_entities` | Search functions, classes by name (fuzzy match) |
|
|
59
|
+
| `get_file_entities` | Get all entities defined in a specific file |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## π¦ Alternative: Global Install
|
|
64
|
+
|
|
65
|
+
If you prefer installing globally instead of using `npx`:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npm install -g @giauphan/codeatlas-mcp
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Then update your MCP config to:
|
|
55
72
|
|
|
56
73
|
```json
|
|
57
74
|
{
|
|
58
75
|
"mcpServers": {
|
|
59
76
|
"codeatlas": {
|
|
60
|
-
"command": "
|
|
61
|
-
"args": ["/absolute/path/to/codeatlas-mcp/dist/index.js"]
|
|
77
|
+
"command": "codeatlas-mcp"
|
|
62
78
|
}
|
|
63
79
|
}
|
|
64
80
|
}
|
|
65
81
|
```
|
|
66
82
|
|
|
67
|
-
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## π§ Environment Variables
|
|
68
86
|
|
|
69
87
|
| Variable | Description |
|
|
70
88
|
|----------|-------------|
|
|
71
|
-
| `CODEATLAS_PROJECT_DIR` |
|
|
89
|
+
| `CODEATLAS_PROJECT_DIR` | Force a specific project directory |
|
|
72
90
|
|
|
73
|
-
|
|
91
|
+
> By default, the server **auto-discovers** all projects with `.codeatlas/analysis.json` under your home directory.
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## π§βπ» Development
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
git clone https://github.com/giauphan/codeatlas-mcp.git
|
|
99
|
+
cd codeatlas-mcp
|
|
100
|
+
npm install
|
|
101
|
+
npm run build
|
|
102
|
+
npm start
|
|
103
|
+
```
|
|
74
104
|
|
|
75
105
|
## License
|
|
76
106
|
|
package/package.json
CHANGED