@suco/su-auggie-mcp 0.1.0 → 0.1.2
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 +48 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,8 @@
|
|
|
1
1
|
# @suco/su-auggie-mcp
|
|
2
2
|
|
|
3
|
-
An MCP (Model Context Protocol) server
|
|
3
|
+
An MCP (Model Context Protocol) server by [Solutions Unity](https://solutionsunity.com) utilizing the [Augment Code SDK](https://www.npmjs.com/package/@augmentcode/auggie-sdk) to expose context engine capabilities.
|
|
4
4
|
|
|
5
|
-
> ⚠️ **Experimental** — This package is a test implementation
|
|
6
|
-
|
|
7
|
-
## Installation
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm install -g @suco/su-auggie-mcp
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
Or use with npx:
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npx @suco/su-auggie-mcp
|
|
17
|
-
```
|
|
5
|
+
> ⚠️ **Experimental** — This package is a test implementation. Use at your own risk.
|
|
18
6
|
|
|
19
7
|
## Usage
|
|
20
8
|
|
|
@@ -25,7 +13,7 @@ Add to your MCP client configuration:
|
|
|
25
13
|
```json
|
|
26
14
|
{
|
|
27
15
|
"mcpServers": {
|
|
28
|
-
"
|
|
16
|
+
"auggie": {
|
|
29
17
|
"command": "npx",
|
|
30
18
|
"args": ["@suco/su-auggie-mcp"]
|
|
31
19
|
}
|
|
@@ -33,9 +21,52 @@ Add to your MCP client configuration:
|
|
|
33
21
|
}
|
|
34
22
|
```
|
|
35
23
|
|
|
24
|
+
### Options
|
|
25
|
+
|
|
26
|
+
| Option | Description |
|
|
27
|
+
|--------|-------------|
|
|
28
|
+
| `-w, --workspace <path>` | Add workspace path (can be repeated or comma-separated) |
|
|
29
|
+
| `--ignore-roots` | Ignore MCP roots and CWD fallback, use only `-w` workspaces |
|
|
30
|
+
| `--debug` | Enable debug mode (logging capability + debug tool) |
|
|
31
|
+
| `-n, --no-persistent` | Disable index persistence (in-memory only, re-indexes on restart) |
|
|
32
|
+
|
|
36
33
|
### Environment Variables
|
|
37
34
|
|
|
38
|
-
|
|
35
|
+
| Variable | Description |
|
|
36
|
+
|----------|-------------|
|
|
37
|
+
| `AUGMENT_API_KEY` | Your Augment Code API key (required) |
|
|
38
|
+
| `AUGMENT_API_URL` | Augment API base URL (optional, for custom endpoints) |
|
|
39
|
+
| `SUCO_AUGGIE_DEBUG` | Set to `1` to enable debug mode |
|
|
40
|
+
|
|
41
|
+
## Tools
|
|
42
|
+
|
|
43
|
+
### `codebase`
|
|
44
|
+
|
|
45
|
+
Semantic search and Q&A over indexed code.
|
|
46
|
+
|
|
47
|
+
| Parameter | Type | Description |
|
|
48
|
+
|-----------|------|-------------|
|
|
49
|
+
| `mode` | `"search"` \| `"ask"` | Operation mode: search for code or ask a question |
|
|
50
|
+
| `query` | `string` | Natural language search query |
|
|
51
|
+
| `prompt` | `string?` | Additional prompt for ask mode (optional) |
|
|
52
|
+
| `root` | `string?` | Workspace root path (optional) |
|
|
53
|
+
|
|
54
|
+
### `index`
|
|
55
|
+
|
|
56
|
+
Manage and inspect codebase indexing state.
|
|
57
|
+
|
|
58
|
+
| Parameter | Type | Description |
|
|
59
|
+
|-----------|------|-------------|
|
|
60
|
+
| `action` | `"status"` \| `"list"` \| `"reindex"` | Action to perform |
|
|
61
|
+
|
|
62
|
+
### `debug` (only with `--debug`)
|
|
63
|
+
|
|
64
|
+
Inspect internal server state for troubleshooting.
|
|
65
|
+
|
|
66
|
+
| Parameter | Type | Description |
|
|
67
|
+
|-----------|------|-------------|
|
|
68
|
+
| `action` | `"state"` \| `"stats"` \| `"config"` \| `"capabilities"` \| `"emit"` | Debug action |
|
|
69
|
+
| `root` | `string?` | Workspace root path (optional) |
|
|
39
70
|
|
|
40
71
|
## Requirements
|
|
41
72
|
|
|
@@ -43,5 +74,5 @@ Add to your MCP client configuration:
|
|
|
43
74
|
|
|
44
75
|
## License
|
|
45
76
|
|
|
46
|
-
|
|
77
|
+
This package is subject to the [Augment Code SDK](https://www.npmjs.com/package/@augmentcode/auggie-sdk) license and usage terms. Solutions Unity provides no warranties, guarantees, or support obligations.
|
|
47
78
|
|