@armature-tech/mcp-analytics 0.2.5

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/NOTICE

@@ -0,0 +1,4 @@
+@armature-tech/mcp-analytics
+Copyright 2026 Armature
+
+This product includes software developed at Armature (https://armature.tech).

package/README.md

@@ -0,0 +1,283 @@
+# @armature-tech/mcp-analytics
+
+Wrapper SDK that instruments MCP servers with analytics telemetry. It decorates each registered tool's input schema with optional `telemetry.*` fields, strips those fields before the original handler runs, and posts a signed ingest batch to Armature after the handler returns.
+
+The SDK is a drop-in for any server built on `@modelcontextprotocol/sdk`'s `McpServer`. It does not introduce a middleware server and does not modify the arguments the original handler sees.
+
+It also exposes recorder primitives for dispatcher-style MCP servers that hand-roll `tools/list` and `tools/call` without using `McpServer.registerTool`, and a `./mastra` subpath export for servers built on `@mastra/mcp`'s `MCPServer`.
+
+> **AI agents integrating this SDK:** read [`SKILL.md`](SKILL.md) for the step-by-step playbook (shape detection, env vars, delivery mode, verification). It also ships in the npm tarball at `node_modules/@armature-tech/mcp-analytics/SKILL.md`.
+
+## Install
+
+```sh
+npm install @armature-tech/mcp-analytics @modelcontextprotocol/sdk zod
+```
+
+## Quick start
+
+Two ways to wire this in, depending on whether you're adopting it on a new server or layering it on top of an existing `McpServer` factory.
+
+### Registry-style (new code)
+
+```ts
+import { createAnalyticsRecorder } from "@armature-tech/mcp-analytics";
+import { z } from "zod";
+
+const analytics = createAnalyticsRecorder({
+  armature: {
+    endpointUrl: "https://app.armature.tech/api/mcp-analytics/ingest",
+    mcpServerId: process.env.ANALYTICS_MCP_SERVER_ID,
+    ingestSecret: process.env.ANALYTICS_INGEST_SECRET,
+  },
+});
+
+analytics.tool<{ customer: string }>(
+  {
+    name: "lookup_customer",
+    description: "Look up a customer by name.",
+    inputSchema: { customer: z.string().min(1) },
+  },
+  async (args) => {
+    return { content: [{ type: "text", text: await lookup(args.customer) }] };
+  },
+);
+
+const server = analytics.createMcpServer({ name: "my-mcp", version: "0.1.0" });
+await server.connect(transport);
+```
+
+`analytics.tool` accepts Zod schemas, JSON Schema, or raw Zod shapes. The handler sees stripped args (the `telemetry` block is removed); the recorder times the call and posts the batch.
+
+### Drop-in (existing `McpServer` factories)
+
+```ts
+import { createMcpAnalyticsServer } from "@armature-tech/mcp-analytics";
+import { createMyMcpServer } from "./my-mcp-server.js";
+
+const server = createMcpAnalyticsServer(
+  () => createMyMcpServer(),
+  {
+    armature: {
+      endpointUrl: "https://app.armature.tech/api/mcp-analytics/ingest",
+      mcpServerId: process.env.ANALYTICS_MCP_SERVER_ID,
+      ingestSecret: process.env.ANALYTICS_INGEST_SECRET,
+    },
+  },
+);
+```
+
+`createMcpAnalyticsServer` intercepts `registerTool` calls made inside the factory, so every tool registered there is instrumented automatically. Use this when you can't change how your existing server defines its tools.
+
+## Dispatcher-style servers
+
+For servers that expose plain JSON Schema tool definitions and dispatch tool calls by name without going through `McpServer.registerTool`, build a recorder and let it own the tool registry:
+
+```ts
+import { createAnalyticsRecorder } from "@armature-tech/mcp-analytics";
+
+const analytics = createAnalyticsRecorder({
+  armature: {
+    endpointUrl: "https://app.armature.tech/api/mcp-analytics/ingest",
+    mcpServerId: process.env.ANALYTICS_MCP_SERVER_ID,
+    ingestSecret: process.env.ANALYTICS_INGEST_SECRET,
+    delivery: "await",
+    actorId: ({ ctx }) => (ctx as RequestContext).userProfileId,
+  },
+});
+
+analytics.tool<{ customer_id: string }>(
+  {
+    name: "lookup_customer",
+    description: "Look up a customer by id.",
+    inputSchema: {
+      type: "object",
+      properties: { customer_id: { type: "string" } },
+      required: ["customer_id"],
+    },
+  },
+  async (args, { ctx }) => {
+    return await db.customers.lookup(args.customer_id, ctx);
+  },
+);
+
+// in your tools/list handler
+return { tools: analytics.toolDefinitions() };
+
+// in your tools/call handler
+return await analytics.dispatch(name, rawArgs, { ctx, sessionId });
+```
+
+The handler sees stripped args — no `telemetry` field — and a `context` object with whatever you passed to `dispatch`. The recorder times the call, records a `tool_call` event (success or error), and rethrows on failure.
+
+## Mastra servers (`@mastra/mcp`)
+
+Servers built on `@mastra/mcp`'s `MCPServer` and Mastra's `createTool()` from
+`@mastra/core/tools` use a different surface than the MCP SDK's `McpServer`. The
+`./mastra` subpath export wraps each tool's `inputSchema` with the telemetry block and
+each `execute` with the recorder — drop the wrapped map straight into `new MCPServer({ tools })`:
+
+```ts
+import { MCPServer } from "@mastra/mcp";
+import { wrapMastraTools } from "@armature-tech/mcp-analytics/mastra";
+
+new MCPServer({
+  id: "my-mcp",
+  name: "My MCP",
+  version: "0.0.1",
+  tools: wrapMastraTools(createMyTools(), {
+    armature: {
+      endpointUrl: "https://app.armature.tech/api/mcp-analytics/ingest",
+      mcpServerId: process.env.ANALYTICS_MCP_SERVER_ID,
+      ingestSecret: process.env.ANALYTICS_INGEST_SECRET,
+      delivery: "await",
+    },
+  }),
+});
+```
+
+For long-lived processes that want a `flush()` handle (`delivery: "background"`), or to
+share one recorder across multiple tool maps, use `createMastraAnalytics`:
+
+```ts
+import { createMastraAnalytics } from "@armature-tech/mcp-analytics/mastra";
+
+const analytics = createMastraAnalytics({
+  armature: { delivery: "background" },
+});
+
+const tools = analytics.wrapTools(createMyTools());
+process.on("SIGTERM", () => analytics.flush());
+```
+
+To propagate `sessionId` / `authInfo` from Mastra's per-call context (the second arg to
+`execute`), pass `resolveExtra`:
+
+```ts
+wrapMastraTools(tools, {
+  armature: { delivery: "await" },
+  resolveExtra: (mastraContext) => ({
+    sessionId: mastraContext?.runtimeContext?.get?.("sessionId"),
+    authInfo: mastraContext?.requestContext?.authInfo,
+  }),
+});
+```
+
+The package does not import `@mastra/*` at runtime (structural typing), so the adapter
+works with any Mastra version that exposes the standard `{ id, inputSchema, execute }`
+tool shape.
+
+### Lower-level entry points
+
+When the registry-first shape doesn't fit (e.g. you already have a tool catalog you don't want to re-declare, or you need to add fields to the batch), the same primitives are exposed individually:
+
+- `analytics.decorateDefinitions(defs)` — decorate an existing list of tool definitions
+- `analytics.instrumentToolCall(event, handler)` — wrap a single handler invocation without registering
+- `analytics.extractTelemetry(args)` + `analytics.recordToolCall(event)` — fully manual
+
+### Delivery and flushing
+
+Pick one of:
+
+- **`delivery: "await"`** (recommended for serverless) — `recordToolCall` resolves only after the batch has been posted. No flush call needed; the example above uses this pattern.
+- **`delivery: "background"`** (default; best for long-lived processes) — `recordToolCall` returns immediately and the post happens on `setImmediate`. Drain pending batches at shutdown with `await analytics.flush()`.
+
+### Recording session_init explicitly
+
+`recordToolCall` already emits a `session_init` event the first time it sees a new `sessionId` (per recorder, per actor). Call `recordSessionInit` directly only when you want the event to fire at MCP handshake time — e.g. inside your `initialize` JSON-RPC handler, before any tool call — so the session is announced even if the client disconnects without invoking a tool.
+
+```ts
+await analytics.recordSessionInit({
+  sessionId,
+  ctx,
+});
+```
+
+### Flushing on the `McpServer` path
+
+`createMcpAnalyticsServer` returns the factory result as-is. If you need access to `flush()` for a serverless `McpServer` deployment, use `withMcpAnalytics` instead — it returns both the factory result and the underlying recorder:
+
+```ts
+const { result, recorder } = withMcpAnalytics(config, createMyMcpServer);
+// ... handle request ...
+await recorder.flush();
+```
+
+### What clients see
+
+Each tool's `inputSchema` gains a `telemetry` object:
+
+- `intent` — short string describing why the agent is calling the tool (optional by default)
+- `context` — optional free-form context
+- `frustration_level` — optional `"low" | "medium" | "high"`
+
+Set `telemetry.intent = "required"` in config if you want to force agents to supply an `intent` with every call:
+
+```ts
+createMcpAnalyticsServer(createMyMcpServer, {
+  telemetry: { intent: "required" },
+});
+```
+
+### What handlers see
+
+The `telemetry` object is stripped before your handler runs. Your tool receives the same `args` object it would have without the SDK.
+
+### What Armature receives
+
+After each tool call (success or error), the SDK posts a signed batch to `endpointUrl` containing a `tool_call` event with timing, status, the input/output previews, and the telemetry fields the agent supplied. The first event for a new `sessionId` is preceded by a `session_init` event.
+
+## Configuration
+
+```ts
+type McpAnalyticsConfig = {
+  telemetry?: {
+    intent?: "required" | "optional"; // default "optional"
+  };
+  armature?: {
+    endpointUrl?: string;     // default reads ANALYTICS_INGEST_URL
+    mcpServerId?: string;     // default reads ANALYTICS_MCP_SERVER_ID
+    ingestSecret?: string;    // default reads ANALYTICS_INGEST_SECRET
+    actorId?: string | ((input) => string | Promise<string>);
+    enabled?: boolean;        // default true
+    delivery?: "background" | "await"; // default "background"
+    timeoutMs?: number;       // default 4000
+    emit?: (batch) => void | Promise<void>; // override the network emitter
+    onError?: (error, batch) => void;
+  };
+};
+```
+
+Notes:
+
+- If `ingestSecret` or `mcpServerId` is missing, the SDK silently skips delivery — useful for local development.
+- `delivery: "background"` (default) returns the tool result immediately and posts the batch on `setImmediate`. Use `delivery: "await"` in serverless environments where the function may exit before background work finishes.
+- The actor id is a SHA-256 of `mcpServerId` + an actor seed. By default the seed comes from the request's auth token / client id / authorization header. Pass a static `armature.actorId` seed for a stable source, or pass a function to derive the seed from `{ ctx, extra, headers, authInfo, toolName, telemetry }`.
+- The signed request includes `X-Armature-Timestamp`, `X-Armature-Signature` (HMAC-SHA256 of `timestamp.body`), and `X-Armature-MCP-Server-Id` headers.
+
+## Environment variables
+
+| Variable | Purpose |
+| --- | --- |
+| `ANALYTICS_INGEST_URL` | Ingest endpoint (defaults to the local mock at `http://127.0.0.1:8787/api/mcp-analytics/ingest`) |
+| `ANALYTICS_MCP_SERVER_ID` | The MCP server's id registered with Armature |
+| `ANALYTICS_INGEST_SECRET` | Shared secret used to sign each batch |
+
+## Lower-level exports
+
+For custom integrations the package also exports building blocks used internally:
+
+- `withMcpAnalytics(config, createServer)` — like `createMcpAnalyticsServer` but returns `{ result, recorder }` so you can call `recorder.flush()` from the `McpServer` path
+- `createAnalyticsRecorder(config)` — dispatcher-style primitives: `decorateDefinitions`, `extractTelemetry`, `recordToolCall`, `recordSessionInit`, and `flush`
+- `decorateInputSchemaWithTelemetry(schema, config)` / `createTelemetryInputSchema(config)` / `createTelemetryJsonSchema(config)`
+- `extractTelemetryArguments(args)` — split `{ telemetry, ...args }`
+- `buildToolCallEvent(...)`, `buildActorId(...)`, `buildEventId(...)`
+- `signIngestBody(body, secret, timestamp)`
+- `postTelemetryEvent(batch, config)` / `emitTelemetryEvent(batch, config)`
+- `defaultMcpAnalyticsConfig`
+
+## Repo layout
+
+- `src/` — the wrapper SDK.
+- `docs/` — architecture notes for the SDK.
+- `experimental/` — local mock servers and demo clients used to exercise the SDK. See `experimental/mock-env/` for details. Anything experimentation-related lives here and is not part of the published package.