@tangle-network/agent-knowledge 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/AGENTS.md +51 -0
  2. package/package.json +3 -2
package/AGENTS.md ADDED
@@ -0,0 +1,51 @@
1
+ # Agent Knowledge Operator Guide
2
+
3
+ Use this package when an agent needs persistent, source-grounded knowledge that improves over time.
4
+
5
+ ## Rules
6
+
7
+ - Register sources before citing them: `agent-knowledge source-add <path>`.
8
+ - Generated pages live under `knowledge/`.
9
+ - Raw evidence lives under `raw/sources/` and should not be edited.
10
+ - Run `agent-knowledge index` after page changes.
11
+ - Run `agent-knowledge lint` before trusting or promoting knowledge.
12
+ - Treat `missing-source` lint findings as blocking.
13
+ - Use `--json` for automation.
14
+
15
+ ## Common Commands
16
+
17
+ ```bash
18
+ agent-knowledge init
19
+ agent-knowledge source-add ./source.md --json
20
+ agent-knowledge apply-write-blocks ./proposal.txt
21
+ agent-knowledge index --json
22
+ agent-knowledge search "query" --json
23
+ agent-knowledge inspect --json
24
+ agent-knowledge explain knowledge/concepts/example.md --json
25
+ agent-knowledge lint --json
26
+ agent-knowledge viz --json
27
+ ```
28
+
29
+ ## Write Proposal Format
30
+
31
+ Agents should stage generated edits as FILE blocks:
32
+
33
+ ```txt
34
+ ---FILE: knowledge/concepts/example.md---
35
+ ---
36
+ id: example
37
+ title: Example
38
+ sources:
39
+ - src_abc123
40
+ ---
41
+ # Example
42
+
43
+ Sourced knowledge with links to [[Related Page]].
44
+ ---END FILE---
45
+ ```
46
+
47
+ The parser rejects absolute paths, `..`, control characters, and writes outside `knowledge/`.
48
+
49
+ ## Eval Boundary
50
+
51
+ Use `runKnowledgeBaseOptimization()` when comparing candidate knowledge bases on an actual task corpus. It delegates to `@tangle-network/agent-eval` multi-shot optimization, so single-turn and multi-turn agents share the same path.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tangle-network/agent-knowledge",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Source-grounded, eval-gated knowledge growth primitives for agents.",
5
5
  "homepage": "https://github.com/tangle-network/agent-knowledge#readme",
6
6
  "repository": {
@@ -31,11 +31,12 @@
31
31
  }
32
32
  },
33
33
  "bin": {
34
- "agent-knowledge": "./dist/cli.js"
34
+ "agent-knowledge": "dist/cli.js"
35
35
  },
36
36
  "files": [
37
37
  "dist",
38
38
  "docs",
39
+ "AGENTS.md",
39
40
  "README.md"
40
41
  ],
41
42
  "publishConfig": {