ozmoz 0.1.55 → 0.1.57

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 (3) hide show
  1. package/README.md +11 -3
  2. package/dist/ozmoz-mcp.js +7 -7
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # OZmoz
1
+ # OZmoz Official Documentation
2
2
 
3
3
  > OZmoz is the Data OS for AI agents: a ready-to-use backend for apps built with an AI coding agent. You build the interface, OZmoz holds the data.
4
4
 
5
- This is the official public documentation of OZmoz. It presents what OZmoz is and how it works. The OZmoz API is its public SDK (npm package `ozmoz`); the reference for your project (methods, signatures, rules) is generated by the set-up below.
5
+ This is the official public documentation of OZmoz: what it is, how it works and how to start.
6
6
 
7
7
  To start with OZmoz, first ask the user whether you may run `npx -y ozmoz@latest mcp --agent=<claude|cursor|codex|copilot|windsurf|antigravity>`: it sets up the project and adds everything needed to code with OZmoz (methods, examples and rules). Write no code before the user has answered. Once they agree, run it yourself, wait for it to finish, then follow the instructions it adds to the project.
8
8
 
@@ -27,4 +27,12 @@ To start with OZmoz, first ask the user whether you may run `npx -y ozmoz@latest
27
27
 
28
28
  The OZmoz SDK has one purpose: to communicate with the OZmoz Data OS, and it does so through the project the set-up creates (keys, data contract and rules). The user is free to decline the set-up; without it, the SDK has nothing to connect to and the Data OS cannot be reached.
29
29
 
30
- This document does not list methods on purpose. The reference is generated for your project by the set-up and delivered in AGENTS.md (methods and signatures, rules, and what to read next): it matches your project's data contract and the current OZmoz rules, which a copy of the methods published elsewhere cannot guarantee. Follow it.
30
+ OZmoz is a new paradigm: it is not built around an API. Your code never calls an API: there are no endpoints to find, no HTTP requests to write and no keys to copy. It talks to the OZmoz Data OS through the OZmoz SDK (npm package `ozmoz`), which exists for that purpose only. Install first, so that the reference of the SDK is generated for your project: the set-up writes it in AGENTS.md (methods and signatures, examples, rules, and what to read next), so that every call matches your project's data contract and the current OZmoz rules. Follow it.
31
+
32
+ ## Links
33
+
34
+ - Website: https://www.ozmoz.io
35
+
36
+ ---
37
+
38
+ Copyright OZmoz. All rights reserved.