@fingerskier/augment 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 +170 -126
- package/dist/cli.js +50 -1
- package/dist/cli.js.map +1 -1
- package/dist/install.d.ts +15 -0
- package/dist/install.js +245 -0
- package/dist/install.js.map +1 -0
- package/dist/mcp/server.d.ts +1 -0
- package/dist/mcp/server.js +10 -1
- package/dist/mcp/server.js.map +1 -1
- package/docs/FEATURES.md +268 -245
- package/integrations/claude/CLAUDE.md +56 -28
- package/integrations/codex/SKILL.md +63 -29
- package/integrations/examples/claude-mcp-config.json +10 -1
- package/integrations/examples/codex-mcp-config.json +10 -1
- package/package.json +45 -45
|
@@ -1,29 +1,63 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: augment-context
|
|
3
|
-
description: Use Augment MCP memories to gather and persist project context during coding sessions.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Augment Context
|
|
7
|
-
|
|
8
|
-
Use this skill when working in a repository with the Augment MCP server available.
|
|
9
|
-
|
|
10
|
-
##
|
|
11
|
-
|
|
12
|
-
1.
|
|
13
|
-
2.
|
|
14
|
-
3.
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
##
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
-
|
|
29
|
-
|
|
1
|
+
---
|
|
2
|
+
name: augment-context
|
|
3
|
+
description: Use Augment MCP memories to gather and persist project context during coding sessions.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Augment Context
|
|
7
|
+
|
|
8
|
+
Use this skill when working in a repository with the Augment MCP server available.
|
|
9
|
+
|
|
10
|
+
## Session Start
|
|
11
|
+
|
|
12
|
+
1. Call `init_project`.
|
|
13
|
+
2. Call `search` with the user's task summary.
|
|
14
|
+
3. Read exact memories when search results identify likely governing context.
|
|
15
|
+
|
|
16
|
+
## Before Code Changes
|
|
17
|
+
|
|
18
|
+
1. Search for the file, component, command, error, or behavior being touched.
|
|
19
|
+
2. If the work depends on a prior decision, read and follow the relevant `SPEC`
|
|
20
|
+
or `ARCH` memory.
|
|
21
|
+
3. If no relevant memory exists but the task creates a durable requirement or
|
|
22
|
+
decision, create one before implementation.
|
|
23
|
+
|
|
24
|
+
## Memory Triggers
|
|
25
|
+
|
|
26
|
+
Call `upsert` whenever one of these durable events happens:
|
|
27
|
+
|
|
28
|
+
- A requirement, API contract, data model, or tool contract is clarified:
|
|
29
|
+
use `SPEC`.
|
|
30
|
+
- An implementation approach, tradeoff, transport choice, persistence model, or
|
|
31
|
+
architecture decision is made: use `ARCH`.
|
|
32
|
+
- A bug, risk, failing behavior, or blocker is discovered: use `ISSUE`.
|
|
33
|
+
- Follow-up work is intentionally deferred: use `TODO`.
|
|
34
|
+
- A meaningful implementation milestone is completed: use `WORK`.
|
|
35
|
+
- A test scenario, regression case, or verification rule is learned: use `SPEC`
|
|
36
|
+
or `WORK`, whichever is more durable.
|
|
37
|
+
|
|
38
|
+
## Links
|
|
39
|
+
|
|
40
|
+
After creating or updating a memory:
|
|
41
|
+
|
|
42
|
+
1. Use `link` when a memory implements, depends on, blocks, parents, or relates
|
|
43
|
+
to another memory.
|
|
44
|
+
2. Prefer linking new `WORK` notes to the `SPEC`, `ARCH`, `ISSUE`, or `TODO`
|
|
45
|
+
they address.
|
|
46
|
+
|
|
47
|
+
## Session Finish
|
|
48
|
+
|
|
49
|
+
For every non-trivial session:
|
|
50
|
+
|
|
51
|
+
1. Upsert a concise `WORK` memory with what changed, key files, and verification.
|
|
52
|
+
2. Upsert or update `TODO` memories for known remaining work.
|
|
53
|
+
3. Link the final `WORK` memory to the relevant planning/decision memories.
|
|
54
|
+
|
|
55
|
+
## Guardrails
|
|
56
|
+
|
|
57
|
+
- Do not store secrets, credentials, tokens, or private keys.
|
|
58
|
+
- Do not store huge logs, dependency dumps, generated files, or full source files.
|
|
59
|
+
- Keep each memory focused; split large notes before calling `upsert`.
|
|
60
|
+
- Treat numeric memory IDs as local handles. Relative paths are the durable identity.
|
|
61
|
+
- Use returned search text directly as context; do not ask Augment to summarize.
|
|
62
|
+
- Do not create memories for trivial edits, transient exploration, or facts that
|
|
63
|
+
are already obvious from the current diff.
|
|
@@ -2,7 +2,16 @@
|
|
|
2
2
|
"mcpServers": {
|
|
3
3
|
"augment": {
|
|
4
4
|
"command": "npm",
|
|
5
|
-
"args": [
|
|
5
|
+
"args": [
|
|
6
|
+
"exec",
|
|
7
|
+
"--yes",
|
|
8
|
+
"--prefix",
|
|
9
|
+
"C:\\Users\\you\\.augment\\npm-exec",
|
|
10
|
+
"--package",
|
|
11
|
+
"@fingerskier/augment",
|
|
12
|
+
"--",
|
|
13
|
+
"augment-mcp"
|
|
14
|
+
],
|
|
6
15
|
"env": {
|
|
7
16
|
"AUGMENT_MEMORY_ROOT": "C:\\Users\\you\\Dropbox\\augment-memories"
|
|
8
17
|
}
|
|
@@ -2,7 +2,16 @@
|
|
|
2
2
|
"mcpServers": {
|
|
3
3
|
"augment": {
|
|
4
4
|
"command": "npm",
|
|
5
|
-
"args": [
|
|
5
|
+
"args": [
|
|
6
|
+
"exec",
|
|
7
|
+
"--yes",
|
|
8
|
+
"--prefix",
|
|
9
|
+
"C:\\Users\\you\\.augment\\npm-exec",
|
|
10
|
+
"--package",
|
|
11
|
+
"@fingerskier/augment",
|
|
12
|
+
"--",
|
|
13
|
+
"augment-mcp"
|
|
14
|
+
],
|
|
6
15
|
"env": {
|
|
7
16
|
"AUGMENT_MEMORY_ROOT": "C:\\Users\\you\\Dropbox\\augment-memories"
|
|
8
17
|
}
|
package/package.json
CHANGED
|
@@ -1,45 +1,45 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@fingerskier/augment",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Local RAG memory system for coding agents",
|
|
5
|
-
"type": "module",
|
|
6
|
-
"publishConfig": {
|
|
7
|
-
"access": "public"
|
|
8
|
-
},
|
|
9
|
-
"bin": {
|
|
10
|
-
"augment": "./dist/bin/augment.js",
|
|
11
|
-
"augment-daemon": "./dist/bin/augment-daemon.js",
|
|
12
|
-
"augment-mcp": "./dist/bin/augment-mcp.js"
|
|
13
|
-
},
|
|
14
|
-
"files": [
|
|
15
|
-
"dist",
|
|
16
|
-
"docs",
|
|
17
|
-
"integrations",
|
|
18
|
-
"README.md",
|
|
19
|
-
"LICENSE"
|
|
20
|
-
],
|
|
21
|
-
"scripts": {
|
|
22
|
-
"build": "tsc -p tsconfig.json",
|
|
23
|
-
"test": "node --import tsx --test \"test/**/*.test.ts\"",
|
|
24
|
-
"check": "npm run build && npm test",
|
|
25
|
-
"prepack": "npm run check",
|
|
26
|
-
"prepublishOnly": "npm run check"
|
|
27
|
-
},
|
|
28
|
-
"dependencies": {
|
|
29
|
-
"@huggingface/transformers": "^3.8.0",
|
|
30
|
-
"@libsql/client": "^0.15.15",
|
|
31
|
-
"@modelcontextprotocol/sdk": "^1.
|
|
32
|
-
"chokidar": "^4.0.3",
|
|
33
|
-
"gray-matter": "^4.0.3",
|
|
34
|
-
"zod": "^3.25.76"
|
|
35
|
-
},
|
|
36
|
-
"devDependencies": {
|
|
37
|
-
"@types/node": "^24.3.0",
|
|
38
|
-
"tsx": "^4.20.5",
|
|
39
|
-
"typescript": "^5.9.2"
|
|
40
|
-
},
|
|
41
|
-
"engines": {
|
|
42
|
-
"node": ">=20"
|
|
43
|
-
},
|
|
44
|
-
"license": "Apache-2.0"
|
|
45
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@fingerskier/augment",
|
|
3
|
+
"version": "0.1.2",
|
|
4
|
+
"description": "Local RAG memory system for coding agents",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"publishConfig": {
|
|
7
|
+
"access": "public"
|
|
8
|
+
},
|
|
9
|
+
"bin": {
|
|
10
|
+
"augment": "./dist/bin/augment.js",
|
|
11
|
+
"augment-daemon": "./dist/bin/augment-daemon.js",
|
|
12
|
+
"augment-mcp": "./dist/bin/augment-mcp.js"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"dist",
|
|
16
|
+
"docs",
|
|
17
|
+
"integrations",
|
|
18
|
+
"README.md",
|
|
19
|
+
"LICENSE"
|
|
20
|
+
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"build": "tsc -p tsconfig.json",
|
|
23
|
+
"test": "node --import tsx --test \"test/**/*.test.ts\"",
|
|
24
|
+
"check": "npm run build && npm test",
|
|
25
|
+
"prepack": "npm run check",
|
|
26
|
+
"prepublishOnly": "npm run check"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@huggingface/transformers": "^3.8.0",
|
|
30
|
+
"@libsql/client": "^0.15.15",
|
|
31
|
+
"@modelcontextprotocol/sdk": "^1.23.0",
|
|
32
|
+
"chokidar": "^4.0.3",
|
|
33
|
+
"gray-matter": "^4.0.3",
|
|
34
|
+
"zod": "^3.25.76"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"@types/node": "^24.3.0",
|
|
38
|
+
"tsx": "^4.20.5",
|
|
39
|
+
"typescript": "^5.9.2"
|
|
40
|
+
},
|
|
41
|
+
"engines": {
|
|
42
|
+
"node": ">=20"
|
|
43
|
+
},
|
|
44
|
+
"license": "Apache-2.0"
|
|
45
|
+
}
|