@weave-kit/engine 0.1.1 → 0.1.2

package/README.md

@@ -1,35 +1,58 @@
 # @weave-kit/engine
 
-> Metadata-driven headless backend engine for PostgreSQL.
+> Let AI agents operate your data — safely.
 
-Author your data model in `schema.json` and the engine compiles it into PostgreSQL tables, a governed
-REST API with field- and row-level RBAC, an immutable audit log, an MCP tool surface for AI agents,
-and object-level TypeScript types. The engine renders no UI and ships no business logic — it turns
-metadata into a database schema, a typed API, and agent tools.
+Define your data model once in `schema.json`, and WeaveKit compiles it into PostgreSQL tables, a
+REST API with row- and field-level RBAC, an immutable audit log, and an MCP tool surface that AI
+agents call with typed tools — never raw SQL. Self-hosted: your data stays in your database.
 
 ```
 objects/leads/schema.json   →   PostgreSQL tables + indexes + RLS
                                 REST API (CRUD + RBAC)
-                                MCP tools (agent surface + guardrails)
-                                Audit log
+                                MCP tools (per-identity surface + guardrails)
+                                Immutable audit log
                                 TypeScript types
 ```
 
+## Why WeaveKit
+
+- **Safe by construction** — every agent action is authorized by row- and field-level RBAC and
+  native PostgreSQL RLS, and recorded in an immutable audit log. Guardrails (and optional
+  approvals) sit in front.
+- **One agent, many users** — each MCP call carries the acting user's identity (on-behalf-of), and
+  the engine compiles a per-identity tool surface: a salesperson's agent sees only their own leads,
+  a finance agent cannot read sales notes. Prompt injection cannot bypass RBAC/RLS.
+- **Bring your existing PostgreSQL** — point the engine at a live database and declare the tables
+  you want to expose; existing tables stay read-only unless you explicitly allow additive DDL, and
+  `weave introspect` can reverse-model them into `schema.json`.
+- **Typed tools in minutes, not weeks** — hand-writing an MCP server (tools + permissions + audit)
+  for a few tables takes days; here it is a few `schema.json` files, and new fields or tables
+  extend the tool surface automatically.
+- **More than MCP** — the same schema also drives a REST API and generated TypeScript types, so
+  people and agents share one governed contract.
+- **Self-hosted** — the engine runs in your environment; no data leaves your database.
+
+## How it works
+
+`weave` reads `objects/<name>/schema.json`, validates it, and syncs it to PostgreSQL (state-diff
+migrations; existing tables stay read-only unless you allow additive DDL). The same metadata drives
+the REST routes and the MCP tool surface, and the data-access layer enforces RBAC and audits every
+write.
+
 ## Features
 
 - **Schema as the source of truth** — `objects/<name>/schema.json`, versioned in Git; state-diff
-  migrations to PostgreSQL (existing tables stay read-only unless explicitly allowed).
+  migrations to PostgreSQL.
 - **Governed REST API** — object CRUD with row-level (`all`/`own`/`team`) and field-level RBAC and a
   uniform error contract.
 - **MCP tool surface** — a streamable HTTP endpoint at `/mcp` with a per-identity tool surface and
   guardrails.
-- **Audit log** — an immutable event log for data mutations (optional subsystem).
-- **Sandboxed hooks** — `*.server.js` lifecycle hooks running in isolated workers (optional
-  subsystem).
+- **Audit log** — an immutable event log for data mutations.
+- **Sandboxed hooks** — `*.server.js` lifecycle hooks running in isolated workers.
 - **Type generation** — object-level TypeScript types derived from the schema.
 - **Live events** — an SSE stream with replay.
-- **Operations** — health / readiness / version endpoints, request rate limiting, CORS and structured
-  logging.
+- **Operations** — health / readiness / version endpoints, request rate limiting, CORS and
+  structured logging.
 
 ## Requirements
 
@@ -63,16 +86,9 @@ weave mcp:config          # ready-to-paste config for Claude Code / Cursor / VS
 ## Documentation
 
 - [Getting started](docs/01-getting-started.md) — scaffold, migrate, run, consume
-- [Schema guide](docs/02-schema.md) — objects, fields, relations, validation
-- [RBAC](docs/03-rbac.md) — permissions, row scopes, field exclusions
-- [Formulas](docs/04-formula.md) — computed fields
-- [Audit](docs/05-audit.md) — immutable event logging
-- [CLI reference](docs/06-weave-cli.md) — every `weave` command
-- [MCP](docs/07-mcp.md) — the agent tool surface
-- [Script hooks](docs/08-script.md) — sandboxed `*.server.js` lifecycle hooks
-- [Public API & dependency budget](docs/10-public-api.md) — entry points and extension points
-- [Quotas & usage budgets](docs/11-quota.md) — durable per-period budgets
-- [Inbound events](docs/12-ingress.md) — receive external events with app-owned verification
+- [Schema guide](docs/02-schema.md) · [RBAC](docs/03-rbac.md) · [Formulas](docs/04-formula.md) · [Audit](docs/05-audit.md)
+- [CLI reference](docs/06-weave-cli.md) · [MCP](docs/07-mcp.md) · [Script hooks](docs/08-script.md)
+- [Public API & dependency budget](docs/10-public-api.md) · [Quotas](docs/11-quota.md) · [Inbound events](docs/12-ingress.md)
 - [Practices](docs/practices/01-customer-integration.md) — real integration walkthroughs
 
 ## Programmatic use
@@ -142,6 +158,10 @@ npm run lint
 Issues and pull requests are welcome. See [`AGENTS.md`](AGENTS.md) for architecture notes and
 contribution invariants.
 
+## Support
+
+Questions, bug reports and security reports: **support@weavekit.io**.
+
 ## License
 
-[MIT](LICENSE)
+[MIT](LICENSE) · For support, contact **support@weavekit.io**.

package/dist/version.d.ts

@@ -1,3 +1,3 @@
 /** engine version — single source of truth for CLI, ops routes and MCP metadata */
-export declare const version = "0.1.1";
+export declare const version = "0.1.2";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,3 +1,3 @@
 /** engine version — single source of truth for CLI, ops routes and MCP metadata */
-export const version = '0.1.1';
+export const version = '0.1.2';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weave-kit/engine",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "WeaveKit engine — metadata-driven headless backend runtime",
   "type": "module",
   "main": "./dist/index.js",
@@ -51,6 +51,11 @@
     "type": "git",
     "url": "https://github.com/weavekit/engine.git"
   },
+  "homepage": "https://github.com/weavekit/engine",
+  "bugs": {
+    "url": "https://github.com/weavekit/engine/issues"
+  },
+  "author": "WeaveKit <support@weavekit.io>",
   "scripts": {
     "dev": "node --watch --import tsx src/index.ts",
     "build": "tsc -p tsconfig.build.json",