mcp-usage-control 1.0.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 reasonable and customary use in 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 Additional Liability. 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 additional liability.
+
+   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 [yyyy] [name of copyright owner]
+
+   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

@@ -0,0 +1,141 @@
+# mcp-usage-control
+
+Core package for concurrency-safe MCP usage enforcement. MCP and storage vendor independent.
+
+> **Current distribution status:** this package is not published to npm yet. Use the repository checkout or a a locally packed `mcp-usage-control-<version>.tgz`. See [Use from source / local tarballs](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/using-from-source.md) / [日本語](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/using-from-source.ja.md).
+
+## English
+
+The current core provides policy quoting, **atomic multi-budget admission**, pending -> cost-liable transitions, renewable leases, explicit settlement, scoped idempotency, provider-neutral observability hooks, reusable Store conformance support, and `MemoryUsageStore` as the process-local reference implementation.
+
+```text
+reserve -> markLiable -> execute -> settle
+             ^             |
+             |--- renew ---|
+```
+
+A quote can apply several budgets to one invocation. Every budget reserves atomically or none does. Replay protection is scoped by `(tenantId, principal.id, tool, operationId)` and settled tombstones default to 24 hours in the reference store.
+
+On successful `UsageControl.reserve()`, the admission result includes both the `lease` and authoritative `remainingByBudget`. Consumers should not recompute remaining capacity from configured limits. Budget keys can be application-sensitive/high-cardinality, so expose or label them only under an explicit application policy.
+
+```ts
+const admission = await control.reserve(request);
+if (admission.allowed) {
+  console.log(admission.remainingByBudget);
+  await admission.lease.markLiable();
+}
+```
+
+Pending expiry releases every participating budget. Cost-liable expiry conservatively keeps the full charge so a crash after execution starts cannot become a refund.
+
+### Long-running `MemoryUsageStore`
+
+`MemoryUsageStore` remains process-local, but controlled long-running single-process deployments can bound retained state:
+
+```ts
+const store = new MemoryUsageStore({
+  maxRetainedOperations: 100_000,
+  maxRetainedBudgetKeys: 100_000,
+});
+```
+
+Capacity exhaustion raises `MemoryUsageStoreCapacityError` and fails closed instead of silently evicting accounting/replay state. `store.stats()` exposes retained-state counts. `store.retireBudgetKey(key)` explicitly retires a completed accounting-window key and rejects keys still referenced by active reservations; the application owns the decision that the window is permanently over and the key will not be reused.
+
+See [Memory store operations](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/memory-store.md). For horizontal scale or restart durability, use a provider-backed shared Store.
+
+`UsageControl` can receive an optional `UsageObserver` and explicit metadata. Observer delivery is best-effort, returned promises are not awaited, and observer failures can never change enforcement state. `onEvent()` itself is invoked inline, so keep synchronous work lightweight. Tool arguments and raw exception messages are not captured automatically.
+
+For low-cardinality operational logs, `projectUsageEvent()` converts raw lifecycle events into a bounded shape that excludes identity IDs, reservation IDs, tool/budget identifiers, arbitrary outcomes, and application-defined denial text by default.
+
+### Operational helper subpaths (v0.10)
+
+The v0.10 operational surface is exposed through explicit subpaths so it remains separate from the authoritative Store contract:
+
+- `mcp-usage-control/operational` — bounded process-local lifecycle snapshots, static runtime identity, and explicit scoped quota projection.
+- `mcp-usage-control/settlement-outcomes` — canonical settlement vocabulary, finite alias normalization, and bounded `invalid_settlement_outcome` diagnostics.
+- `mcp-usage-control/thresholds` — pure absolute/percentage remaining-threshold evaluation and above -> reached crossing detection.
+
+These helpers never infer accounting windows, entitlement, pricing, refund eligibility, or provider health policy. See [Operational usability](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/operational-usability.md).
+
+- [Current source/tarball usage](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/using-from-source.md)
+- [Getting started](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/getting-started.md)
+- [Memory store operations](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/memory-store.md)
+- [Observability](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/observability.md)
+- [Operational usability](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/operational-usability.md)
+- [API reference](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/api-reference.md)
+- [Architecture](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/architecture.md)
+
+Authentication, payments/billing, MCP SDK integration, and provider-backed production storage belong outside this package.
+
+## 日本語
+
+current coreはpolicy quote、**atomic multi-budget admission**、pending -> cost-liable transition、renewable lease、explicit settlement、scoped idempotency、provider-neutral observability hook、再利用可能なStore conformance support、process-local reference implementationの `MemoryUsageStore` を提供します。
+
+```text
+reserve -> markLiable -> execute -> settle
+             ^             |
+             |--- renew ---|
+```
+
+1 invocationへ複数budgetを適用でき、全budgetをatomicにreserveするか、どれもreserveしません。replay protectionは `(tenantId, principal.id, tool, operationId)` 単位で、reference storeのsettled tombstone defaultは24時間です。
+
+`UsageControl.reserve()` 成功時のadmission resultには `lease` とauthoritativeな `remainingByBudget` の両方が含まれます。consumer側でconfigured limitからremainingを再計算しないでください。budget keyにはapplication-sensitive / high-cardinalityな値が含まれ得るため、公開やmetric label化は明示的なapplication policyの下でだけ行います。
+
+```ts
+const admission = await control.reserve(request);
+if (admission.allowed) {
+  console.log(admission.remainingByBudget);
+  await admission.lease.markLiable();
+}
+```
+
+pending expiryは全budgetを解放し、cost-liable expiryはexecution開始後crashがrefundにならないようfull chargeを保守的に維持します。
+
+### `MemoryUsageStore` の長期運用
+
+`MemoryUsageStore` はprocess-localのままですが、管理されたlong-running single-process deploymentではretained stateをbounded化できます。
+
+```ts
+const store = new MemoryUsageStore({
+  maxRetainedOperations: 100_000,
+  maxRetainedBudgetKeys: 100_000,
+});
+```
+
+capacity exhaustion時はaccounting / replay stateをsilent evictionせず `MemoryUsageStoreCapacityError` でfail closedします。`store.stats()` でretained-state数を確認できます。`store.retireBudgetKey(key)` は終了済みaccounting-window keyを明示退役し、active reservation参照中のkeyはrejectします。windowが永久に終了し、そのkeyを同じwindowとして再利用しないという判断はapplication側が所有します。
+
+詳しくは [Memory Storeの長期運用](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/memory-store.ja.md)。horizontal scaleやrestart durabilityが必要ならprovider-backed shared Storeを使います。
+
+`UsageControl` へoptionalな `UsageObserver` と明示metadataを渡せます。observer deliveryはbest-effortで、返されたPromiseをawaitせず、observer failureがenforcement stateを変更することはありません。`onEvent()` 自体はinlineで呼ばれるため同期処理は軽量にしてください。tool argumentsやraw exception messageは自動収集しません。
+
+low-cardinalityな運用logには `projectUsageEvent()` を使えます。raw lifecycle eventからidentity ID、reservation ID、tool / budget identifier、任意outcome、application定義denial textをdefaultで除外したbounded shapeへ変換します。
+
+### Operational helper subpath (v0.10)
+
+v0.10のoperational surfaceはauthoritative Store contractと分離した明示subpathとして公開します。
+
+- `mcp-usage-control/operational` — bounded process-local lifecycle snapshot、static runtime identity、明示scopeしたquota projection。
+- `mcp-usage-control/settlement-outcomes` — canonical settlement vocabulary、finite alias normalization、boundedな `invalid_settlement_outcome` diagnostic。
+- `mcp-usage-control/thresholds` — absolute / percentage remaining threshold評価と above -> reached crossing detectionのpure helper。
+
+これらはaccounting window、entitlement、pricing、refund可否、provider health policyを推測しません。詳しくは [Operational usability](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/operational-usability.ja.md)。
+
+- [現在のsource / tarball利用手順](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/using-from-source.ja.md)
+- [Getting started](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/getting-started.ja.md)
+- [Memory Storeの長期運用](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/memory-store.ja.md)
+- [Observability](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/observability.ja.md)
+- [Operational usability](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/operational-usability.ja.md)
+- [API reference](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/api-reference.ja.md)
+- [Architecture](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/architecture.ja.md)
+
+authentication、payment / billing、MCP SDK integration、provider-backed production storageはこのpackageの責務外です。
+
+## Atomic vector usage (v0.7)
+
+For one logical operation that consumes unlike units, use `VectorUsagePolicy` + `VectorUsageControl` with a Store that implements optional `VectorUsageStore`. Each dimension keeps its own units and hierarchical budgets; unlike units are never summed. Vector admission, progressive growth, expiry/recovery, and settlement are atomic across the complete dimension set.
+
+Store authors can validate the optional capability with `runVectorUsageStoreConformance()` from `mcp-usage-control/conformance`.
+
+## Operation reconciliation (v0.8)
+
+`OperationReconciliationStore` is the optional scalar read capability, and v0.13 adds the parallel `VectorOperationReconciliationStore` capability for initial vector-reserve acknowledgement ambiguity. `MemoryUsageStore` implements both. The conformance subpath exports scalar and vector reconciliation conformance helpers for third-party Stores. Unknown or unprovable state rejects and remains fail closed; reconciliation never authorizes business replay. Cloudflare remains an explicit scalar-only remote reconciliation exception. See [Operation reconciliation/status](https://github.com/git-ksk/mcp-usage-control/blob/main/docs/operation-reconciliation.md).