@axorum/mcp 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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

@@ -1,3 +1,242 @@
-# Temporary Holding Version
+# `@axorum/mcp`
 
-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.
+The official **MCP server** for Axorum. It exposes the Axorum agent plane as MCP tools, so
+that any MCP-capable agent — Claude Code, Claude Desktop, anything else that speaks the
+protocol — becomes an Axorum-governed spender with **no integration code written**.
+
+Axorum is a deontic financial-control ledger. An agent submits an *intent envelope*; the
+service permits or refuses it under the policy in force, and **records the outcome either
+way**.
+
+Which is the point of this server:
+
+> It is safe to hand a language model money-moving tools **precisely because** Axorum sits
+> underneath, refusing what the policy forbids and recording the refusal. The guardrail is
+> not a prompt asking the model to be careful. It is a ledger that will not post what it is
+> not permitted to post.
+
+ESM-only, Node ≥ 20. Speaks stdio.
+
+> **This package and `@axorum/client` release together, at one version, from one tag.**
+> The client is published first and the release waits until npm serves it, so the range
+> this package declares always resolves. Between releases the tree runs ahead of npm; that
+> is expected and affects nobody installing from the registry. `clients/RELEASING.md` has
+> the ceremony.
+
+## Install
+
+Installing it as a dependency needs nothing but npm:
+
+```sh
+npm install @axorum/mcp
+```
+
+Working on it in this repository, `clients/` is one pnpm workspace and the build is
+topological — the client compiles before this package typechecks against it:
+
+```sh
+cd clients
+pnpm install
+pnpm -r run build
+```
+
+## Configuration
+
+All configuration is environment. It is validated **at startup**, and a bad value stops the
+process with a message that names the variable and says what to set it to — an MCP server
+is launched into a void, with no terminal and nobody watching, so a misconfiguration must
+not surface as tool calls failing strangely twenty minutes in.
+
+| Variable | Required | Meaning |
+| --- | --- | --- |
+| `AXORUM_BASE_URL` | **yes** | The service root, e.g. `http://127.0.0.1:8080`. The `/api/v1` prefix is added for you. |
+| `AXORUM_AGENT_URI` | **yes** | The `agent://` URI this server acts as. Must already be bound to a party in the ledger's registry. |
+| `AXORUM_ATTESTATION` | **one of** | The PASETO v4.public capability attestation, inline. |
+| `AXORUM_ATTESTATION_FILE` | **one of** | A path to a file holding one. |
+| `AXORUM_TIMEOUT_MS` | no | Per-request timeout. Defaults to `30000`. |
+| `AXORUM_FAILOVER_URLS` | no | Every other replica's service root, comma-separated, e.g. `https://axorum-1:8443,https://axorum-2:8443`. Reads move to the next replica on a refused connection, a timeout or a `421`, and a submission goes once to the replica that last answered. Each must be a bare origin on `AXORUM_BASE_URL`'s scheme, listed once. Unset, `AXORUM_BASE_URL` must reach the primary. |
+
+`AXORUM_BEARER_TOKEN` is **retired**. The agent plane authenticates with the attestation — carried inside the envelope on submits, and as `Authorization: Bearer <attestation>` on the party-scoped reads. If it is still set the server ignores it and warns on stderr; unset it.
+
+Setting **both** `AXORUM_ATTESTATION` and `AXORUM_ATTESTATION_FILE` is a hard failure, not a
+precedence rule. Two claims about which credential an agent spends money under is exactly
+the configuration where a silent precedence rule sends the wrong credential and nobody finds
+out until the audit.
+
+### Minting an attestation
+
+The attestation is a PASETO v4.public token proving this agent holds the capabilities the
+policy requires. Mint one with the `agent-uri` CLI:
+
+```sh
+agent-uri attest issue \
+  --agent-uri agent://example.com/agent/clerk_01h455vb4pex5vsknk084sn02q \
+  --capability agent/post \
+  --key ./issuer.key \
+  > ./axorum.attestation
+```
+
+The issuer's public key must be registered as a trust root on the service, and the agent URI
+must be bound to a party — both are admin-plane operations, done once by an operator.
+
+## Registering with Claude Code
+
+```sh
+claude mcp add axorum \
+  --env AXORUM_BASE_URL=http://127.0.0.1:8080 \
+  --env AXORUM_AGENT_URI=agent://example.com/agent/clerk_01h455vb4pex5vsknk084sn02q \
+  --env AXORUM_ATTESTATION_FILE=/etc/axorum/axorum.attestation \
+  -- npx axorum-mcp
+```
+
+Or, in a Claude Desktop `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "axorum": {
+      "command": "npx",
+      "args": ["axorum-mcp"],
+      "env": {
+        "AXORUM_BASE_URL": "http://127.0.0.1:8080",
+        "AXORUM_AGENT_URI": "agent://example.com/agent/clerk_01h455vb4pex5vsknk084sn02q",
+        "AXORUM_ATTESTATION_FILE": "/etc/axorum/axorum.attestation"
+      }
+    }
+  }
+}
+```
+
+The model **cannot choose its own identity.** Which agent this server acts as, and what
+authority it holds, come from the operator's environment. There is no argument a model can
+pass to any tool to make this server act as somebody else.
+
+## The tools
+
+| Tool | Does |
+| --- | --- |
+| `submit_intent` | Proposes a financial action. The ledger permits or refuses it, and records what it did. **This is the tool**; the rest exist to inform a call to it. |
+| `get_active_policy` | The id of the policy in force, or a plain statement that none is. |
+| `get_currencies` | Every declared currency with its minor-unit exponent. An amount in any other currency is refused with cause `undeclared_currency`. |
+| `get_transaction` | The stored record for a transaction id — including a recorded refusal. |
+| `get_obligations` | Your agent's open duties. |
+| `get_balance` | An account's net balance, in minor units. |
+| `get_usage` | A metered resource's consumed / metered / billed running totals, and the headroom left. |
+
+Each tool's description is written as a **prompt**, not as documentation: it is the text the
+model reads when deciding whether to call the tool and what to pass it. So each one says
+when to use the tool, what a refusal means, that retrying a transaction id is safe, and what
+*not* to do — do not retry a refusal, do not follow a `not_primary` redirect.
+
+### Metered spend is one intent
+
+`submit_intent` takes three optional usage moves — `consume_usage` (you used a metered
+resource), `meter_usage` (it has been measured), `bill_usage` (it has been billed for). They
+ride the *same* intent as the money entries and commit atomically with them.
+
+The ledger holds them to one rule: `0 <= billed <= metered <= consumed`. Metering more than
+was consumed is **phantom usage**; billing more than was metered is billing with nothing to
+back it. Breaking either refuses the **entire** intent — the journal entries do not post
+either — and the model is told so in the ledger's own compliance English, with exact
+figures, plus the advice not to retry it unchanged.
+
+`get_usage` reads the totals back. Its result leads with the ledger's own plain-English
+narration of the balance, then states the headroom that bounds the next lawful move, so a
+model learns its limit from a sentence rather than by doing arithmetic on JSON. An
+unreconciled chain is a lawful transient, and the description says so — a model should not
+try to "fix" it.
+
+Usage reads are **owner-scoped and fail-closed**: a rival-owned balance, an ownerless one,
+and one that never existed all answer the same `unknown_usage`. The description tells the
+model to conclude only that it cannot read the balance — never that the balance is absent.
+
+## Why a refusal is not an error
+
+When the policy in force forbids an action, the intent still reaches the commit point, is
+still judged, and the refusal is still **recorded**. The ledger answers `200`. So this
+server returns it as an ordinary tool result, with `isError` **unset**, leading with a line
+the model reads first:
+
+```
+Refused — nothing posted. The policy in force forbids this action, and the refusal itself
+is now recorded on the ledger. This is a verdict, not a failure: the system worked exactly
+as intended. Do NOT retry this unchanged — it will be refused again, identically. Either
+propose an action the policy allows, or tell your human that the policy forbids this and
+that a human has to change the policy to permit it.
+```
+
+The model reads that, and adapts. That loop is the entire product.
+
+## Outcome provenance
+
+Structured outcomes preserve the TypeScript client's recorded provenance. Its optional
+`semantics` field names the evaluation law; in MCP tool text it is rendered as an exact
+decimal string alongside other TypeScript `bigint` values. It is omitted for
+pre-versioning records and for archived provenance. `master_data` is likewise omitted
+when the policy did not consult replicated reference data.
+
+Dressing a refusal as an error would break it in a specific and bad way. `isError` is the
+channel that means *the tool malfunctioned* — and a well-built agent's response to a
+malfunction is to **retry**. A refusal flagged as an error therefore invites the model to
+retry the exact thing the policy just forbade, in a loop, and to report to its human that
+Axorum is broken rather than that the spend was denied. The refusal is the most valuable
+thing this ledger produces. It goes in the content, in plain language, where the model will
+read it.
+
+`isError` is reserved for the cases where the ledger **never got to answer at all**: this
+process is misconfigured, the service is unreachable, the policy pin would not hold, the
+cluster could not confirm a commit. Those results carry the machine-readable error `code`
+and the load-bearing extras a caller needs to act — `active` (without which nothing can
+re-pin) and `primary_api_addr` (the primary's API origin as the follower last knew it, a hint that may be stale).
+
+Note the one verdict that catches people out: `ForbiddenRecorded` is **forbidden and posted
+anyway** — a policy whose stance is to record rather than block. `posted` is not the inverse
+of "forbidden", and this server says so in prose rather than leaving a model to skim for the
+word.
+
+## Money is text
+
+Amounts are integer **minor units** (cents, not dollars) written as **decimal strings**:
+
+```json
+{ "minor": "50000", "currency": "USD" }
+```
+
+That is $500.00.
+
+The strings are not fussiness. The ledger's minor units are 128-bit integers, and every JSON
+parser between a model and this process decodes a bare number as an IEEE-754 double, which
+holds integers exactly only up to 2^53. A `minor` declared as a JSON *number* would be
+silently rounded for any large value, and the ledger would faithfully post the rounded
+figure. Balances come back as strings for the same reason.
+
+Malformed amounts are refused rather than guessed at. `"10.00"`, `"1e3"` and `"1_000"` are
+all rejected: a financial-control server that interprets an ambiguous amount is worse than
+one that declines it.
+
+## Idempotency
+
+The `transaction` id is the ledger's **idempotency key**. Re-submitting an id that already
+committed replays its stored outcome instead of posting twice — which is what makes retrying
+a submission safe. Omit it and one is minted for you, once, before the first attempt.
+
+This is why `submit_intent` can recover from a policy that moved mid-flight without any risk
+of double-posting, and why the one genuinely ambiguous failure — an unconfirmed cluster
+commit — is safe to resolve either by retrying or by reading the transaction back.
+
+## Development
+
+```sh
+pnpm typecheck   # tsc --noEmit, strict
+pnpm build       # → dist/, with a shebang on dist/main.js
+pnpm test        # unit + integration
+```
+
+The integration suite is not mocked. It spawns the real `conformance_server` binary — a
+genuine `axorum-serve` — bootstraps it over the admin HTTP API, points a real `McpServer` at
+it, and connects a real MCP `Client` over a linked in-memory transport pair. Every assertion
+travels the whole path: MCP client → JSON-RPC → tool → `@axorum/client` → HTTP → the real
+policy engine, and back. The refusal it asserts on is a real refusal, from a real policy.
+
+The binary is **prebuilt** by the Rust workspace (`target/debug/examples/conformance_server`).
+The suite never invokes cargo.

package/dist/config.d.ts

@@ -0,0 +1,52 @@
+/**
+ * The server's configuration, read from the environment and checked before anything runs.
+ *
+ * An MCP server is launched by an agent host — Claude Code, Claude Desktop — as a
+ * subprocess speaking JSON-RPC over stdio. Nobody is watching its stdout. So a
+ * misconfiguration must not surface as a tool call failing strangely twenty minutes in;
+ * it must stop the process at startup with a message that names the variable, says what
+ * was wrong with it, and says what to set it to. That is what this module is for.
+ *
+ * @packageDocumentation
+ */
+/** A validated configuration. Nothing constructs one but {@link loadConfig}. */
+export interface ServerConfig {
+    /** The Axorum service's root, e.g. `http://127.0.0.1:8080`. */
+    readonly baseUrl: string;
+    /** The agent's `agent://` URI, bound to a party in the ledger's registry. */
+    readonly agentUri: string;
+    /** The PASETO v4.public capability attestation proving this agent may act. */
+    readonly attestation: string;
+    /** An optional per-request timeout, in milliseconds. */
+    readonly timeoutMs?: number;
+    /**
+     * Every other replica's service root, in the order to try them after `baseUrl`. Empty
+     * when `AXORUM_FAILOVER_URLS` is unset: `baseUrl` is then assumed to reach the primary.
+     */
+    readonly failoverUrls: readonly string[];
+}
+/**
+ * The configuration was wrong, and the server will not start.
+ *
+ * Distinct from `@axorum/client`'s own `ConfigError`: this one is about *this process's
+ * environment*, and its message is written to be read by a human editing an MCP host's
+ * config file.
+ */
+export declare class ConfigurationError extends Error {
+    constructor(message: string);
+}
+/** How to read the attestation file. Injected so the validator stays testable. */
+export type ReadFile = (path: string) => string;
+/**
+ * Reads and validates the configuration from an environment.
+ *
+ * A **pure function** of `(env, readFile)` — which is the reason every one of its failure
+ * messages can be held to account by a unit test without setting a single real environment
+ * variable or writing a single real file.
+ *
+ * @param env - The environment. `process.env` in production.
+ * @param readFile - How to read `AXORUM_ATTESTATION_FILE`. Defaults to the filesystem.
+ * @throws {ConfigurationError} With a message that names the variable and says what to do.
+ */
+export declare function loadConfig(env?: NodeJS.ProcessEnv, readFile?: ReadFile): ServerConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAMH,gFAAgF;AAChF,MAAM,WAAW,YAAY;IAC3B,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,8EAA8E;IAC9E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,wDAAwD;IACxD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAKD,kFAAkF;AAClF,MAAM,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAKhD;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,GAAG,GAAE,MAAM,CAAC,UAAwB,EACpC,QAAQ,GAAE,QAAuB,GAChC,YAAY,CAiCd"}