@svashevchenko/ez-know
v0.5.0
Published
!!! Important: early development stage !!!
Downloads
709
Readme
ez-know
!!! Important: early development stage !!!
A business knowledge layer for your agents and your team.
You'll find it useful when:
- You have a complex project with lots of entities, features and rules to govern them all;
- Your agents break your apps when they miss some important spec;
- Your team have a hard time answering questions like "Did we implement this right", "Does this feature conflict with existing rules and domains".
What's in the box
- MCP server + agent skills
- REST server + UI for human-friendly experience
Core concepts
Structured knowledge extraction
Domain
-> Entity
-> Entity Relationship
-> Feature
-> Capability
-> Business Rule
-> Constraint
-> Rationale
-> Evidence
-> QuestionEvery statement must have evidence And your codebase contains it all. Evidence can come from code,
And confidence in it is measurable.
Question is also a knowledge element
No direct knowledge base editing via model
Patch workflow
How to run
Install package globally with npm i -g @svashevhcenko/ez-know.
Shell commands:
ez-knowfor package overview and all important info;ez-know initto install bundled skills, prompts for folder;ez-know mcpstarts the MCP server over stdio;ez-know reststarts the REST service over the knowledge base with the web UI.
Add MCP server to your agent's config:
[mcp_servers.ez-know]
command = "ez-know"
args = ["mcp"]
[mcp_servers.ez-know.env]
EZ_KNOW_ROOT = "path/for/knowledge/files"{
"mcpServers": {
"ez-know": {
"command": "ez-know",
"args": [
"mcp"
],
"env": {
"EZ_KNOW_ROOT": "path/for/knowledge/files",
}
}
}
}Env config:
| env | default | desc |
|----|---|-----|
| EZ_KNOW_ROOT | ./ez-know relative to the current working directory | Knowledge root used by MCP, REST, patch drafts, and resource-backed tools. |
| EZ_KNOW_REST_HOST | 127.0.0.1 | Host for the REST service. |
| EZ_KNOW_REST_PORT | 3000 | Port for the REST service. Takes precedence over PORT. |
| PORT | 3000 | Fallback REST port when EZ_KNOW_REST_PORT is not set. |
| EZ_KNOW_LEGACY_RESOURCES | false | Enables legacy MCP fallback tools: list_mcp_resources, list_mcp_resource_templates, and read_mcp_resource. Any truthy value except 0, false, off, or no enables them. |
| EZ_KNOW_PATCH_SCOPE_FILE_THRESHOLD | 100 | Maximum number of files per generated scope partition during patch scope and evidence coverage workflows. Invalid values fall back to 100. |
Example REST startup:
EZ_KNOW_ROOT=./ez-know ez-know rest