@tangle-network/agent-knowledge 1.5.1 → 1.5.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.
Files changed (2) hide show
  1. package/README.md +24 -0
  2. package/package.json +17 -11
package/README.md CHANGED
@@ -4,12 +4,36 @@ Source-grounded, eval-gated knowledge growth primitives for agents.
4
4
 
5
5
  This package turns raw sources and generated markdown knowledge into a versionable graph that agents can search, lint, evaluate, and improve over time. It is intentionally domain-agnostic: legal, tax, coding, research, finance, business, and scientific workflows define their own policies and rubrics on top.
6
6
 
7
+ ## Contents
8
+
9
+ - [Install](#install)
10
+ - [Start here](#start-here) — pick CLI vs programmatic
11
+ - [CLI](#cli) — `init` → `source-add` → `index` → `search` → `lint`
12
+ - [Design](#design) — the invariants (immutable sources, cited claims, deterministic graph)
13
+ - [Agent-Eval integration](#agent-eval-integration) — readiness bundles + release reports
14
+ - [Research loop](#research-loop) — `runKnowledgeResearchLoop` + control-loop adapter
15
+ - [Researcher profile](#researcher-profile) — sandbox `AgentProfile` for `runLoop`
16
+ - [Pluggable knowledge sources](#pluggable-knowledge-sources) — live authorities → eval re-runs
17
+
7
18
  ## Install
8
19
 
9
20
  ```bash
10
21
  pnpm add @tangle-network/agent-knowledge @tangle-network/agent-eval
11
22
  ```
12
23
 
24
+ ## Start here
25
+
26
+ Two ways in, depending on what you're doing:
27
+
28
+ - **Author / inspect a KB by hand** → the [CLI](#cli) (`init` → `source-add` → `index` → `search` → `lint`). Fastest way to see the shape on disk.
29
+ - **Drive it from an agent** → pick the primitive by intent:
30
+ - *"Does the agent have enough context to run?"* → [`buildEvalKnowledgeBundle`](#agent-eval-integration) (block / ask / acquire before execution).
31
+ - *"Grow the KB as a researcher"* → [`runKnowledgeResearchLoop`](#research-loop) (deterministic mechanics; your agent owns judgment) or the sandbox [researcher profile](#researcher-profile) for `runLoop`.
32
+ - *"Does this candidate KB actually improve task success?"* → `runKnowledgeBaseOptimization` ([Agent-Eval integration](#agent-eval-integration)).
33
+ - *"Keep live authorities fresh"* → [pluggable sources](#pluggable-knowledge-sources) + `detectChanges` → eval re-runs.
34
+
35
+ Storage stays consumer-owned via `KbStore` (`MemoryKbStore`, `FileSystemKbStore`, or your own D1/Postgres). Every primitive below is source-grounded: claims cite immutable source records, and lint fails on un-grounded citations.
36
+
13
37
  ## CLI
14
38
 
15
39
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tangle-network/agent-knowledge",
3
- "version": "1.5.1",
3
+ "version": "1.5.2",
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": {
@@ -52,6 +52,16 @@
52
52
  "publishConfig": {
53
53
  "access": "public"
54
54
  },
55
+ "scripts": {
56
+ "build": "tsup",
57
+ "dev": "tsup --watch",
58
+ "prepare": "tsup",
59
+ "test": "vitest run",
60
+ "test:watch": "vitest",
61
+ "typecheck": "tsc --noEmit",
62
+ "lint": "biome check src tests",
63
+ "format": "biome format --write src tests"
64
+ },
55
65
  "dependencies": {
56
66
  "@tangle-network/agent-eval": "^0.42.0",
57
67
  "@tangle-network/agent-runtime": "^0.25.0",
@@ -65,17 +75,13 @@
65
75
  "typescript": "^5.7.0",
66
76
  "vitest": "^3.0.0"
67
77
  },
78
+ "pnpm": {
79
+ "minimumReleaseAge": 4320,
80
+ "minimumReleaseAgeExclude": []
81
+ },
68
82
  "engines": {
69
83
  "node": ">=20"
70
84
  },
71
85
  "license": "MIT",
72
- "scripts": {
73
- "build": "tsup",
74
- "dev": "tsup --watch",
75
- "test": "vitest run",
76
- "test:watch": "vitest",
77
- "typecheck": "tsc --noEmit",
78
- "lint": "biome check src tests",
79
- "format": "biome format --write src tests"
80
- }
81
- }
86
+ "packageManager": "pnpm@10.28.0"
87
+ }