@svashevchenko/ez-know 0.1.0 → 0.2.0
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 +20 -18
- package/dist/cli.js +1038 -746
- package/dist/cli.js.map +4 -4
- package/dist/rest/server.js +520 -15
- package/dist/rest/server.js.map +4 -4
- package/dist/server.js +584 -292
- package/dist/server.js.map +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
# ez-know
|
|
2
|
+
|
|
2
3
|
!!! Important: early development stage !!!
|
|
3
4
|
|
|
4
5
|
A business knowledge layer for your agents and your team.
|
|
@@ -6,7 +7,7 @@ A business knowledge layer for your agents and your team.
|
|
|
6
7
|
When do you need it?
|
|
7
8
|
- You have a complex project with lots of entities, features and rules to govern them all;
|
|
8
9
|
- Your agents break your apps when they miss some important spec;
|
|
9
|
-
- Your team have a hard time answering questions like "Did we implement this right", "Does this feature conflict with
|
|
10
|
+
- Your team have a hard time answering questions like "Did we implement this right", "Does this feature conflict with existing rules and domains".
|
|
10
11
|
|
|
11
12
|
## What's in the box
|
|
12
13
|
|
|
@@ -19,38 +20,40 @@ As a multiple products dev, I frequently need to
|
|
|
19
20
|
|
|
20
21
|
## How to run
|
|
21
22
|
|
|
22
|
-
Install globally with `npm i -g ez-know`, then
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
- `ez-know rest` starts the REST service and serves the frontend UI
|
|
23
|
+
Install globally with `npm i -g @svashevhcenko/ez-know`, then add in your agent's config:
|
|
24
|
+
```yaml
|
|
25
|
+
[mcp_servers.ez-know]
|
|
26
|
+
command = "ez-know"
|
|
27
|
+
args = ["mcp"]
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
[mcp_servers.ez-know.env]
|
|
30
|
+
EZ_KNOW_ROOT = "path/for/knowledge/files"
|
|
31
|
+
```
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
Shell commands:
|
|
34
|
+
- `ez-know` for package overview and all important info;
|
|
35
|
+
- `ez-know init` to install bundled skills, prompts for folder;
|
|
36
|
+
- `ez-know mcp` starts the MCP server over stdio;
|
|
37
|
+
- `ez-know rest` starts the REST service over knowledge base with web UI. Also needs EZ_KNOW_ROOR env.
|
|
32
38
|
|
|
33
|
-
|
|
34
|
-
- `npm run dev:rest` starts only REST
|
|
35
|
-
- `npm run dev:web` starts only the web app
|
|
36
|
-
|
|
37
|
-
Configuration
|
|
39
|
+
Env configuration:
|
|
38
40
|
|
|
39
41
|
| env| default | desc |
|
|
40
42
|
|----|---|-----|
|
|
41
43
|
|EZ_KNOW_ROOT| ez-know|path relative to PWD where you want to store knowledge data |
|
|
42
44
|
|EZ_KNOW_REST_HOST| |host for the rest service|
|
|
43
45
|
|EZ_KNOW_REST_PORT| |port for the rest service |
|
|
46
|
+
|EZ_KNOW_LEGACY_RESOURCES| false| expose tools for resources interaction|
|
|
44
47
|
|
|
45
48
|
## How does it work?
|
|
46
49
|
|
|
47
50
|
|
|
48
|
-
DDD-discovery
|
|
49
|
-
Knowledge engineering
|
|
50
51
|
|
|
52
|
+
Skills define basic workflow, MCP provides instructions and sche
|
|
51
53
|
|
|
54
|
+
DDD-discovery
|
|
55
|
+
Knowledge engineering
|
|
52
56
|
|
|
53
|
-
The built package also exposes the same runtime entrypoints through npm scripts:
|
|
54
57
|
|
|
55
58
|
## Included Tools
|
|
56
59
|
|
|
@@ -58,7 +61,6 @@ The built package also exposes the same runtime entrypoints through npm scripts:
|
|
|
58
61
|
- `knowledge_patch` manages draft patches with create, list, get, add/update/delete operation, validate, and close actions.
|
|
59
62
|
- `knowledge_patch_apply` mutates canonical knowledge JSON only after explicit approval plus the latest validation fingerprint.
|
|
60
63
|
|
|
61
|
-
|
|
62
64
|
## Knowledge Patch Workflow
|
|
63
65
|
|
|
64
66
|
Patch drafts live under `EZ_KNOW_ROOT/.patches/<patch-id>/` and contain only:
|