@cyanmycelium/mcp-persistence 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Guillaume Pelletier (CyanMycelium)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

package/README.md

@@ -1,3 +1,184 @@
-# Temporary Holding Version
+<p align="center">
+  <img src="docs/assets/logo.png" alt="mcp-persistence: the cyan panda keeping durable data archives" width="180" />
+  <img src="docs/assets/mcp-broker-family.png" alt="MCP Broker Family" width="64" height="64" />
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# mcp-persistence
+
+Durable JSON documents, immutable revisions and streamed binary artifacts for the CyanMycelium MCP family. SQLite keeps revisions, references and idempotency; an internal file directory keeps artifact bytes. The broker decides access.
+
+**Status: initial release 0.1.0.** Node.js 22.13 or later is required; its built-in `node:sqlite` API is experimental on Node 22. This is a local single-writer backend, with integration tests, not a distributed storage service.
+
+```text
+Explorer / Mission Control / MCP client
+                  |
+              mcp-broker
+                  |
+       slot persistence, PersistenceBehavior
+                  | broker decisions per resource
+          IPersistenceStore
+                  |
+     SQLite revisions + internal artifact files
+
+Binary upload/download -> loopback HTTP endpoint
+                  | forwards caller bearer to a fresh broker MCP check
+                  +-> bounded file stream, never base64 over MCP
+```
+
+Applications own document schemas, migrations and scene restoration. Persistence stores the states they provide and never restarts their operations.
+
+## MCP contract for client development
+
+Start with the [wire contract and examples](docs/mcp-contract.md), the [machine-readable JSON schemas](contracts/persistence.v1.json), and the [TypeScript store interface](src/contract/persistence.store.ts). These describe `persistence.v1`, revision 1, independently of SQLite. Import `@cyanmycelium/mcp-persistence/protocol` for backend-independent tool schemas or load `@cyanmycelium/mcp-persistence/contracts/persistence.v1.json`. The behavior publishes the same tool definitions used to generate the manifest. Tests validate live MCP inputs and outputs against these schemas.
+
+```sh
+npm run contracts
+```
+
+Regenerate the manifest after intentional protocol changes. Client teams can use its descriptors and fixtures while backend work continues.
+
+## Develop locally
+
+```sh
+npm install
+npm run build
+npm test
+npm run dev
+```
+
+For an npm installation, install `@cyanmycelium/mcp-broker` as well to use the optional `--dev` embedded broker. In a checkout it is already a development dependency.
+
+`npm run dev` starts its own broker on `127.0.0.1:3000`, the provider and the transfer endpoint on `127.0.0.1:3001`. It explicitly selects `openGuard()`, so no token or policy is needed. The startup banner identifies this mode. Stop any broker already using port 3000, or choose another port with `MCP_PERSISTENCE_BROKER_URL`. Storage defaults to `./data-dev`.
+
+On Windows, Node cannot synchronize directory entries. Choose the weaker file-sync durability explicitly before launch:
+
+```powershell
+$env:MCP_PERSISTENCE_ALLOW_FILE_SYNC_ONLY = '1'
+npm run dev
+```
+
+This setting preserves SQLite transactions and synchronizes artifact file contents, but does not guarantee artifact directory entries against power loss. Without the opt-in, Windows startup is refused. On systems supporting directory fsync, leave the option unset for file-and-directory synchronization. Storage must be a canonical local directory, under operator control, with no symlinks or competing writer.
+
+## Move to production
+
+Read the broker's [HOWTO: development, policy tests and production](https://github.com/pandaGaume/mcp-broker/blob/main/HOWTO.md). It is supplied with the accompanying broker changes and may need that commit before the GitHub link resolves. It explains `openGuard()`, `auth.dev`, provider identities, OAuth and the access verification matrix.
+
+Production uses an independently managed broker. The normal entry point uses `BrokerAccessGuard` and fails startup if its provider credential or accepted declaration is missing. It never falls back to `openGuard()`.
+
+```powershell
+$env:MCP_PERSISTENCE_BROKER_URL = 'https://mcp.example.com'
+$env:MCP_PERSISTENCE_RESOURCE_ROOT = '/site1/persistence'
+$env:MCP_PERSISTENCE_DATA = 'C:\ServiceData\mcp-persistence'
+# Inject MCP_PERSISTENCE_PROVIDER_SECRET through the service environment.
+# It must match the provider secretEnv entry in the broker security file.
+npm start
+```
+
+On Windows the explicit file-sync opt-in above is also required. Serve the transfer endpoint behind an HTTPS reverse proxy; it always binds loopback. Preserve Authorization and streaming. Every transfer forwards the caller's bearer to the configured broker slot for a new access decision before opening bytes. A known upload id, artifact id or URL grants no permission. A stream already opened is not automatically interrupted by later revocation.
+
+Do not carry `--dev` into the service command. `auth.dev` belongs to the broker and keeps the policy active; use normal `npm start` with that broker when testing policy locally. The transfer server has no standalone open-mode CLI switch.
+
+## Configuration
+
+| variable | default / meaning |
+|---|---|
+| `MCP_PERSISTENCE_BROKER_URL` | `http://127.0.0.1:3000`, broker origin |
+| `MCP_PERSISTENCE_RESOURCE_ROOT` | `/local/persistence`, must match broker policy |
+| `MCP_PERSISTENCE_PROVIDER_SECRET` | required outside `--dev`, own provider identity |
+| `MCP_PERSISTENCE_DATA` | `./data-dev` in dev, `./data` otherwise |
+| `MCP_PERSISTENCE_TRANSFER_PORT` | `3001`, loopback HTTP listener |
+| `MCP_PERSISTENCE_LOCALE` | `en`, or `fr` for mcp-core grammar |
+| `MCP_PERSISTENCE_ALLOW_FILE_SYNC_ONLY` | `1` explicitly permits weaker Windows file durability |
+
+The library's `ISqlitePersistenceOptions` configures size limits and minimum retention. Purge is disabled by infinite retention unless a finite `retentionMs` is explicitly configured in the application assembly. There is no automatic retention job.
+
+## Use from TypeScript
+
+See [examples/explorer.mjs](examples/explorer.mjs) for a checkpoint saved through a real MCP client. `PersistenceSlotStore` implements the same `IPersistenceStore` as the local `SqlitePersistenceStore`.
+
+```ts
+const store = new SqlitePersistenceStore({ directory: '/srv/persistence' });
+const context = { subject: 'trusted-internal-application' };
+const saved = await store.putAsync({
+    namespace: 'explorer', id: 'checkpoint-1', kind: 'checkpoint',
+    schemaVersion: '1', expectedRevision: 0,
+    payload: { sessionId: 'session-1', camera: { position: [0, 0, 10] } },
+    references: [], idempotencyKey: crypto.randomUUID()
+}, context);
+await store.closeAsync();
+```
+
+The direct store is an internal trusted API. A remote store ignores `context.subject`; it never sends that value as caller identity. The broker authenticates the connected MCP client. Reuse a mutation's idempotency key after a lost response, along with the identical request.
+
+## Tools and resources
+
+| tools | broker capability |
+|---|---|
+| `persistence.capabilities` | public protocol and effective limits |
+| `persistence.get`, `list`, `listRevisions` | `persistence.read`, per document; list entries are filtered |
+| `persistence.put` | `persistence.write`; referenced targets additionally require read |
+| `persistence.delete` | `persistence.delete`, logical tombstone |
+| `persistence.beginArtifact` | `persistence.write` on the namespace artifact creation target `_new` |
+| `persistence.uploadAccess`, `commitArtifact`, `abortArtifact` | `persistence.write` on the generated artifact target |
+| `persistence.getArtifact` | `persistence.read` on the artifact |
+| `persistence.purge` | `persistence.admin`, plus retention/reference checks |
+
+Each name above has the `persistence.` prefix. Documents and artifacts occupy `<root>/namespaces/<namespace>/documents/<id>` and `<root>/namespaces/<namespace>/artifacts/<id>`. Namespace and id are single validated segments, at most 128 ASCII letters, digits, dots, underscores or hyphens, beginning with a letter, digit or underscore. Business UNS identifiers remain application data.
+
+Templates on the provider's own slot:
+
+- `persistence://documents/{namespace}/{id}`
+- `persistence://documents/{namespace}/{id}/revisions/{revision}`
+- `persistence://artifacts/{namespace}/{id}`
+
+`persistence://capabilities` is public protocol metadata. EN and FR grammars use mcp-core. `_all` exposes opted-in tools and prompts, not resources.
+
+## Guarantees and limits
+
+- `expectedRevision: 0` creates only. Updates and tombstones must match the current revision. Historical revisions stay immutable until authorized purge.
+- Document writes, reference checks, namespace quota accounting and idempotency results commit in one SQLite transaction, with WAL and synchronous=FULL.
+- Keys are retained at least seven days. Direct stores scope them to subject and namespace. MCP scopes them to namespace because broker caller references are request-scoped. Use UUID keys across applications sharing a namespace. Reuse with different content conflicts; rights are checked before a replay. Actor ownership of an upload follows resource rights, not a claimed user id.
+- Incomplete or wrong-hash uploads never become artifacts. Files are verified, synchronized and renamed before metadata publication. Restart reconciles staged/final files and verifies committed content before serving. Unlink pending after a purge remains quota-accounted until collection.
+- Lists use encrypted authenticated cursors, bound to filters, namespace and the store context, expiring after fifteen minutes. Limits apply before authorization filtering, so a filtered page may be empty with a next cursor. Keep following nextCursor. Lists spanning requests are not snapshots.
+- Default limits: 1 MiB document request, 256 references, 50 entries per page (maximum 200), 10 GiB artifact and 100 GiB logical namespace quota. Four uploads per store subject are active at once, therefore four across the MCP slot. Idempotency has 100,000 entries per namespace. Quota accounting includes retained revisions, reserved upload bytes, artifact metadata, idempotency and pending file deletion; filesystem and SQLite page overhead are additional.
+- Uploads expire after 24 hours. An interrupted stream restarts from byte zero. Completion and abort are replayable. No public bearer download links or file paths are returned.
+
+The configured 10 GiB maximum is a limit, not a throughput claim. Tests transfer 512 KiB in bounded chunks. Full hash verification on commit, download and startup is synchronous and can block Node on large archives. Load testing and asynchronous verification are still needed before a high-volume deployment. One process owns one data root; use a single provider instance per root.
+
+## Backup and restore
+
+Stop the provider cleanly and wait for transfers and SQLite checkpointing to finish. Copy the entire data directory to a protected backup destination, including the database, artifact files and cursor key. Do not copy only a live SQLite main file while omitting its WAL. Do not copy the provider environment or credentials into an application export.
+
+Restore into a new canonical data root while the service is stopped. Verify backup file hashes from your backup system, set `MCP_PERSISTENCE_DATA` to that root and start the provider. Startup checks schema compatibility and committed artifact hashes; a missing or corrupt committed file refuses startup. Read a known document and pinned artifact before returning traffic. An offline restore must be exercised with the actual filesystem and backup tool used in production. Application operations are never restarted by restoration.
+
+## Layout and tests
+
+`src/contract/` holds the shared types; `src/sqlite/` implements documents and files; `src/server/` provides behavior, client and broker declaration; `src/provider/` assembles the executable and byte-transfer endpoint. `/conformance` exports a Vitest suite reusable on direct backends and through the slot.
+
+```sh
+npm run typecheck
+npm run build
+npm test
+```
+
+Tests cover restart, competing updates, idempotence, quotas, incomplete and corrupt transfers, rename-before-commit recovery, evidence references, pagination, real broker decisions, HTTP transfer authorization and explicit dev versus normal startup.
+
+The initial [architecture proposal](docs/brief_persistence_slot.md) records the design. Runtime deviations and current guarantees are specified here, particularly namespace-scoped MCP idempotence and authenticated streaming without reusable tickets.
+
+## MCP family
+
+| project | responsibility |
+|---|---|
+| [mcp-core](https://github.com/pandaGaume/mcp-core) | behaviors, adapters, schemas, resources and grammars |
+| [mcp-broker](https://github.com/pandaGaume/mcp-broker) | transport, identity, policy decisions and audit |
+| [mcp-uns](https://github.com/pandaGaume/mcp-uns) | UNS conventions and shared access guard |
+| [mcp-vault](https://github.com/pandaGaume/mcp-vault) | sealed secrets and configuration |
+| [mcp-cache](https://github.com/pandaGaume/mcp-cache) | values with a time to live |
+| [mcp-history](https://github.com/pandaGaume/mcp-history) | time series |
+| mcp-persistence | durable documents, pinned revisions and artifacts |
+
+The family emblem identifies the ecosystem; it is not a certification.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).