@synapsor/runner 0.1.0-alpha.1 → 0.1.0-alpha.3

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 (51) hide show
  1. package/README.md +20 -14
  2. package/TRADEMARKS.md +23 -0
  3. package/dist/cli.d.ts.map +1 -1
  4. package/dist/cli.js +15 -8723
  5. package/dist/runner.mjs +8864 -0
  6. package/docs/MCP_RUNNER_IMPLEMENTATION_PLAN.md +187 -0
  7. package/docs/README.md +56 -0
  8. package/docs/architecture.md +65 -0
  9. package/docs/capability-config.md +180 -0
  10. package/docs/cloud-mode.md +140 -0
  11. package/docs/config-migrations.md +67 -0
  12. package/docs/demo-transcript.md +73 -0
  13. package/docs/dependency-license-inventory.md +35 -0
  14. package/docs/first-10-minutes.md +147 -0
  15. package/docs/getting-started-own-database.md +367 -0
  16. package/docs/licensing.md +38 -0
  17. package/docs/limitations.md +75 -0
  18. package/docs/local-mode.md +246 -0
  19. package/docs/local-ui.md +163 -0
  20. package/docs/mcp-audit.md +146 -0
  21. package/docs/mcp-client-setup.md +155 -0
  22. package/docs/mcp-efficiency-benchmark.md +84 -0
  23. package/docs/operations.md +38 -0
  24. package/docs/own-db-20-minutes.md +185 -0
  25. package/docs/production-readiness.md +39 -0
  26. package/docs/protocol.md +90 -0
  27. package/docs/recipes.md +61 -0
  28. package/docs/roadmap.md +13 -0
  29. package/docs/schema-inspection.md +88 -0
  30. package/docs/security-boundary.md +70 -0
  31. package/docs/shadow-mode.md +67 -0
  32. package/docs/telemetry.md +28 -0
  33. package/docs/threat-model.md +25 -0
  34. package/docs/troubleshooting-first-run.md +248 -0
  35. package/docs/trusted-context.md +70 -0
  36. package/docs/writeback-executors.md +128 -0
  37. package/examples/dangerous-mcp-tools.json +88 -0
  38. package/examples/reference-support-billing-app/README.md +86 -0
  39. package/examples/reference-support-billing-app/docker-compose.yml +13 -0
  40. package/examples/reference-support-billing-app/mcp-client.generic.json +11 -0
  41. package/examples/reference-support-billing-app/schema.sql +55 -0
  42. package/examples/reference-support-billing-app/scripts/run-demo.sh +7 -0
  43. package/examples/reference-support-billing-app/seed.sql +26 -0
  44. package/examples/reference-support-billing-app/synapsor.runner.json +136 -0
  45. package/package.json +10 -4
  46. package/recipes/accounts.trial_extension.json +42 -0
  47. package/recipes/billing.late_fee_waiver.json +46 -0
  48. package/recipes/credits.account_credit.json +45 -0
  49. package/recipes/orders.refund_review.json +57 -0
  50. package/recipes/support.ticket_resolution.json +51 -0
  51. package/dist/bin.cjs +0 -13
package/README.md CHANGED
@@ -1,27 +1,34 @@
1
1
  # Synapsor Runner
2
2
 
3
- Commit-safe MCP runner for Postgres and MySQL agents.
3
+ Safe database tools for AI agents.
4
4
 
5
- Synapsor Runner lets an MCP agent request database-backed business actions
6
- without receiving raw SQL, write credentials, approval tools, or commit tools.
7
- It exposes semantic tools, creates proposals, records evidence, requires
8
- approval outside the model-facing tool surface, and applies approved writes
9
- through guarded execution.
5
+ Turn Postgres/MySQL into reviewed MCP capabilities, not raw SQL. Synapsor
6
+ Runner lets an MCP agent inspect scoped data and request database-backed
7
+ business actions without receiving raw SQL, write credentials, approval tools,
8
+ or commit tools.
10
9
 
11
10
  ## Run The Alpha
12
11
 
13
12
  ```bash
14
- npx -y -p @synapsor/runner@alpha synapsor-runner --help
13
+ npx -y -p @synapsor/runner@alpha synapsor --help
14
+ npx -y -p @synapsor/runner@alpha synapsor demo --quick
15
+ npx -y -p @synapsor/runner@alpha synapsor audit --example dangerous-db-mcp
15
16
  ```
16
17
 
18
+ `synapsor` is the public command. `synapsor-runner` remains available as a
19
+ backward-compatible alias for earlier alpha commands.
20
+
21
+ `synapsor demo --quick` is fixture-only and does not require Docker. Use
22
+ `synapsor demo` for the disposable local Postgres-backed demo.
23
+
17
24
  Use it with a local or staging database:
18
25
 
19
26
  ```bash
20
27
  export DATABASE_URL="postgresql://readonly_user:password@localhost:5432/app"
21
- npx -y -p @synapsor/runner@alpha synapsor-runner inspect --engine auto --from-env DATABASE_URL --schema public
22
- npx -y -p @synapsor/runner@alpha synapsor-runner init --wizard --engine auto --from-env DATABASE_URL --schema public
23
- npx -y -p @synapsor/runner@alpha synapsor-runner tools preview
24
- npx -y -p @synapsor/runner@alpha synapsor-runner mcp serve
28
+ synapsor inspect --engine auto --from-env DATABASE_URL --schema public
29
+ synapsor init --wizard --engine auto --from-env DATABASE_URL --schema public
30
+ synapsor tools preview
31
+ synapsor mcp serve
25
32
  ```
26
33
 
27
34
  For a longer local session, you can install the alpha package explicitly:
@@ -50,9 +57,8 @@ local proposals, evidence, receipts, and replay data in a local SQLite store.
50
57
 
51
58
  ## Command Name
52
59
 
53
- This package installs the `synapsor-runner` binary. It intentionally does not
54
- install a `synapsor` binary because the hosted Synapsor SDK package already owns
55
- that command.
60
+ This package installs `synapsor` as the primary binary and `synapsor-runner` as
61
+ a backward-compatible alias.
56
62
 
57
63
  ## Scope
58
64
 
package/TRADEMARKS.md ADDED
@@ -0,0 +1,23 @@
1
+ # Trademark Policy
2
+
3
+ Apache License 2.0 grants copyright and patent rights to the code in this
4
+ repository. It does not grant trademark rights.
5
+
6
+ The names "Synapsor" and "Synapsor Runner", Synapsor logos, and Synapsor brand
7
+ assets may not be used to imply endorsement or to operate a confusingly similar
8
+ hosted service.
9
+
10
+ Forks may accurately describe themselves as:
11
+
12
+ - "based on Synapsor Runner";
13
+ - "built with Synapsor Runner";
14
+ - "compatible with Synapsor Runner".
15
+
16
+ Forks may not call themselves "Synapsor", use Synapsor branding as their own
17
+ product branding, or imply that Synapsor sponsors, endorses, or operates the
18
+ fork.
19
+
20
+ Hosted or commercial services based on this code must use their own branding.
21
+
22
+ For trademark permission requests, use the contact form at
23
+ https://synapsor.ai/contact.
package/dist/cli.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAiBA,OAAO,EAOL,KAAK,gBAAgB,EAEtB,MAAM,mCAAmC,CAAC;AAiC3C,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAqC1D;AA0DD,KAAK,SAAS,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE9E,wBAAsB,aAAa,CACjC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,GAAE;IACP,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;CACvC,GACL,OAAO,CAAC,MAAM,CAAC,CA0KjB"}
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAiBA,OAAO,EAOL,KAAK,gBAAgB,EAEtB,MAAM,mCAAmC,CAAC;AA0H3C,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAqC1D;AA0DD,KAAK,SAAS,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE9E,wBAAsB,aAAa,CACjC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,GAAE;IACP,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;CACvC,GACL,OAAO,CAAC,MAAM,CAAC,CA0KjB"}