agentfootprint 12.1.0 → 12.2.0

package/dist/esm/mcp/pool/options.d.ts

@@ -0,0 +1,183 @@
+/**
+ * options — what `mcpClientPool` is built from, read and checked once.
+ *
+ * Pattern: one options type + one reader that refuses by name.
+ * Role:    The pool's budgets and clocks (`docs/design/2026-10-mcp-client-pool.md`
+ *          § 3.1). Every number is checked when the pool is built, never at the
+ *          first call. The pool takes the `mcpClient` options that shape one
+ *          connection and hands them to every client it opens; it never takes
+ *          `connection`, because it must build the transport itself — to end
+ *          the session, to hear the tools-changed notice, and to place the send
+ *          gate.
+ */
+import type { MemoryIdentity } from '../../memory/identity/types.js';
+import { type McpReplayOptions } from '../replay.js';
+import type { RetryOnThrottle } from '../throttleRetry.js';
+import type { McpJsonSchemaValidator, McpSdk, McpTransport } from '../types.js';
+import type { McpPoolReport } from './record.js';
+import type { PoolClientOpener } from './plan.js';
+/** The identity a pool keys a client by: `{ tenant?, principal?, conversationId }`. */
+export type McpPoolIdentity = MemoryIdentity;
+/** What a conversation's tool list may be shared under: two names the app vouches for. */
+export interface McpPoolShareContext {
+    /**
+     * What the transport hides in its code — a signer's role, the credentials of
+     * an AWS client, a custom `fetch`. Hashed into the context, never recorded.
+     */
+    readonly configuration: string;
+    /**
+     * What the server's tool visibility depends on — a role and a policy version
+     * (`'analyst@policy-7'`). A version in the name reaches a new entry without
+     * `permissionsChanged`, for conversations that already have a client too:
+     * their tools are listed again under the new name, and a tool bound under the
+     * old one is refused before it is sent. Hashed into the context, never
+     * recorded.
+     */
+    readonly authorization: string;
+}
+/**
+ * Share tool definitions between conversations — declared by the app, checked by
+ * the pool. `share` is asked for every conversation before anything opens, and
+ * again at every listing, every call and every send gate after that, so a
+ * changed answer takes effect at the next one; it must be synchronous and
+ * cheap. A listing's answer is kept only if the names still give the context it
+ * was listed for when it arrives — otherwise it is dropped and listed again. Return both names, or `undefined` to keep that conversation's list to
+ * itself. Conversations share a list only when the transport's comparable
+ * data, both names and the tenant are all equal. A `share` that throws refuses
+ * the open (`init-failed`) or, for a conversation that already has a client,
+ * that listing or call (`binding-changed`) — its error as `cause`. Never share
+ * a server whose list follows the session (one that unlocks tools as a
+ * conversation goes on).
+ */
+export interface McpPoolDefinitionSharing {
+    readonly share: (identity: McpPoolIdentity) => McpPoolShareContext | undefined;
+}
+/** Options for {@link mcpClientPool}. */
+export interface McpClientPoolOptions {
+    /** The server's name: every tool's `source`, the provider's id, and the record. */
+    readonly name: string;
+    /**
+     * The transport each client is opened over. A FUNCTION of the identity is
+     * preferred: it is called before each client opens (and again for every
+     * replacement) with the identity the client is for, so each client gets a
+     * transport — and a session map — of its own, and a provider can vend THAT
+     * user's credential. One shared object serves every client; a shared
+     * `'reuse'` runtime transport then needs `maxClients + maxEnding` at or below
+     * its 256 remembered connections.
+     */
+    readonly transport: McpTransport | ((identity: McpPoolIdentity) => McpTransport);
+    /** Open clients — opening, busy or idle. Default 64. */
+    readonly maxClients?: number;
+    /** Open clients for one principal (one tenant's principal). Default 8. */
+    readonly maxClientsPerPrincipal?: number;
+    /** Clients being ended at once, until each ending's work has settled. Default 8. */
+    readonly maxEnding?: number;
+    /**
+     * Opens, listings, calls and endings outstanding on any client, each from
+     * its admission until its work has settled — not merely until its caller was
+     * answered. Default 256. Size it above `maxEnding`.
+     */
+    readonly maxOperations?: number;
+    /** One open per conversation, under this ceiling. Default 30 000 ms. */
+    readonly initTimeoutMs?: number;
+    /**
+     * End a client idle this long, at the next pool interaction (no timer is
+     * installed). Default 600 000 ms — below AgentCore Runtime's 900 s idle
+     * timeout; set it lower for a runtime configured lower.
+     */
+    readonly idleMs?: number;
+    /** An app lease (`acquire`) is revoked past this. Default 900 000 ms (15 minutes). */
+    readonly maxLeaseMs?: number;
+    /** A tool list is listed again after this, at the next list. Default 600 000 ms. */
+    readonly definitionTtlMs?: number;
+    /** `'per-client'` (the default), or the app's declared sharing contract. */
+    readonly definitions?: 'per-client' | McpPoolDefinitionSharing;
+    /** Refuse an identity without a `principal`. Default `true`. */
+    readonly requirePrincipal?: boolean;
+    /** Refuse an identity without a `tenant` — for multitenant hosts. Default `false`. */
+    readonly requireTenant?: boolean;
+    /**
+     * What happens outside a run — endings, deferred endings, revoked leases,
+     * work that settled after its deadline. Ids and outcomes only. A throwing
+     * handler is swallowed and changes nothing.
+     */
+    readonly onEvent?: (report: McpPoolReport) => void;
+    /** Passed to every client: how a tool's result is decoded (`McpClientOptions.resultMode`). */
+    readonly resultMode?: 'text' | 'structured' | 'structured-or-json';
+    /** Passed to every client: the `initialize` identity. */
+    readonly clientInfo?: {
+        readonly name: string;
+        readonly version: string;
+    };
+    /** Passed to every client: the 429 retry (`McpClientOptions.retryOnThrottle`). */
+    readonly retryOnThrottle?: RetryOnThrottle;
+    /**
+     * Passed to every client: who may send a tool call again
+     * (`McpClientOptions.replay`). Read and checked when the pool is built. The
+     * default stays `'compatibility'`. Whatever the policy, the pool's own send
+     * gate refuses a pooled request it cannot check (`request-unmatched`).
+     */
+    readonly replay?: McpReplayOptions;
+    /** Passed to every client: the two SDK modules, imported by you (`McpClientOptions.sdk`). */
+    readonly sdk?: McpSdk;
+    /**
+     * Passed to every client: the JSON Schema validator a tool's own output checks
+     * use (`McpClientOptions.jsonSchemaValidator`). With `sdk`, give it: a shared
+     * definition always runs its own checks, and without a validator a tool that
+     * declares an `outputSchema` is refused unsent.
+     */
+    readonly jsonSchemaValidator?: McpJsonSchemaValidator;
+    /** Clock seam — tests drive idle, lease and definition ages without waiting. */
+    readonly now?: () => number;
+    /** @internal Test seam: how a client is opened (the real path is `openPooledClient`). */
+    readonly _open?: PoolClientOpener;
+}
+/** The defaults, named so a test and a docstring cannot drift from the code. */
+export declare const MCP_POOL_DEFAULTS: Readonly<{
+    maxClients: 64;
+    maxClientsPerPrincipal: 8;
+    maxEnding: 8;
+    maxOperations: 256;
+    initTimeoutMs: 30000;
+    idleMs: 600000;
+    maxLeaseMs: 900000;
+    definitionTtlMs: 600000;
+}>;
+/** At most this many shared definition entries are kept; the least recently used goes first. */
+export declare const MAX_DEFINITION_ENTRIES = 256;
+/** A list longer than this is used by its own client and never shared. */
+export declare const MAX_SHARED_TOOLS = 512;
+/** The pool's settings, read once. */
+export interface PoolSettings {
+    readonly name: string;
+    readonly transport: (identity: McpPoolIdentity) => McpTransport;
+    readonly maxClients: number;
+    readonly maxClientsPerPrincipal: number;
+    readonly maxEnding: number;
+    readonly maxOperations: number;
+    readonly initTimeoutMs: number;
+    readonly idleMs: number;
+    readonly maxLeaseMs: number;
+    readonly definitionTtlMs: number;
+    readonly share: McpPoolDefinitionSharing['share'] | undefined;
+    readonly requirePrincipal: boolean;
+    readonly requireTenant: boolean;
+    readonly onEvent: ((report: McpPoolReport) => void) | undefined;
+    readonly client: {
+        readonly resultMode?: McpClientPoolOptions['resultMode'];
+        readonly clientInfo?: McpClientPoolOptions['clientInfo'];
+        readonly retryOnThrottle?: RetryOnThrottle;
+        readonly replay?: McpReplayOptions;
+        readonly sdk?: McpSdk;
+        readonly jsonSchemaValidator?: McpJsonSchemaValidator;
+    };
+    readonly now: () => number;
+    readonly open: PoolClientOpener | undefined;
+}
+/**
+ * Read `options` once.
+ *
+ * @throws TypeError naming the option, when one is missing, mistyped or out of
+ *   range, or when `connection` is given — here, when the pool is built.
+ */
+export declare function readPoolOptions(options: McpClientPoolOptions): PoolSettings;

package/dist/esm/mcp/pool/options.js

@@ -0,0 +1,119 @@
+/**
+ * options — what `mcpClientPool` is built from, read and checked once.
+ *
+ * Pattern: one options type + one reader that refuses by name.
+ * Role:    The pool's budgets and clocks (`docs/design/2026-10-mcp-client-pool.md`
+ *          § 3.1). Every number is checked when the pool is built, never at the
+ *          first call. The pool takes the `mcpClient` options that shape one
+ *          connection and hands them to every client it opens; it never takes
+ *          `connection`, because it must build the transport itself — to end
+ *          the session, to hear the tools-changed notice, and to place the send
+ *          gate.
+ */
+import { replayDeclarationOf } from '../replay.js';
+/** The defaults, named so a test and a docstring cannot drift from the code. */
+export const MCP_POOL_DEFAULTS = Object.freeze({
+    maxClients: 64,
+    maxClientsPerPrincipal: 8,
+    maxEnding: 8,
+    maxOperations: 256,
+    initTimeoutMs: 30_000,
+    idleMs: 600_000,
+    maxLeaseMs: 900_000,
+    definitionTtlMs: 600_000,
+});
+/** At most this many shared definition entries are kept; the least recently used goes first. */
+export const MAX_DEFINITION_ENTRIES = 256;
+/** A list longer than this is used by its own client and never shared. */
+export const MAX_SHARED_TOOLS = 512;
+/**
+ * Read `options` once.
+ *
+ * @throws TypeError naming the option, when one is missing, mistyped or out of
+ *   range, or when `connection` is given — here, when the pool is built.
+ */
+export function readPoolOptions(options) {
+    if (options === null || typeof options !== 'object') {
+        throw new TypeError('mcpClientPool: options must be an object with `name` and `transport`.');
+    }
+    const { name } = options;
+    if (typeof name !== 'string' || name.trim() === '') {
+        throw new TypeError('mcpClientPool: `name` must be a non-empty string — the server name every tool and record carries.');
+    }
+    const where = `mcpClientPool[${name}]`;
+    if (options.connection !== undefined) {
+        throw new TypeError(`${where}: \`connection\` is not taken. The pool builds every client's transport itself — ` +
+            'to end its session, to hear the tools-changed notice and to place the send gate. Pass ' +
+            '`transport`, or a function of the identity that returns one.');
+    }
+    const transport = transportOf(options.transport, where);
+    const count = (key) => positiveInteger(options[key], MCP_POOL_DEFAULTS[key], key, where);
+    const definitions = options.definitions ?? 'per-client';
+    if (definitions !== 'per-client' && typeof definitions?.share !== 'function') {
+        throw new TypeError(`${where}: \`definitions\` must be 'per-client' or { share: (identity) => names | undefined }.`);
+    }
+    if (options.onEvent !== undefined && typeof options.onEvent !== 'function') {
+        throw new TypeError(`${where}: \`onEvent\` must be a function.`);
+    }
+    if (options.now !== undefined && typeof options.now !== 'function') {
+        throw new TypeError(`${where}: the clock option must be a function returning milliseconds.`);
+    }
+    // Refused by field now, as each client would refuse it at its first open.
+    if (options.replay !== undefined)
+        replayDeclarationOf(options.replay, where);
+    return {
+        name,
+        transport,
+        maxClients: count('maxClients'),
+        maxClientsPerPrincipal: count('maxClientsPerPrincipal'),
+        maxEnding: count('maxEnding'),
+        maxOperations: count('maxOperations'),
+        initTimeoutMs: count('initTimeoutMs'),
+        idleMs: count('idleMs'),
+        maxLeaseMs: count('maxLeaseMs'),
+        definitionTtlMs: count('definitionTtlMs'),
+        share: definitions === 'per-client' ? undefined : definitions.share,
+        requirePrincipal: flag(options.requirePrincipal, true, 'requirePrincipal', where),
+        requireTenant: flag(options.requireTenant, false, 'requireTenant', where),
+        onEvent: options.onEvent,
+        client: {
+            ...(options.resultMode !== undefined && { resultMode: options.resultMode }),
+            ...(options.clientInfo !== undefined && { clientInfo: options.clientInfo }),
+            ...(options.retryOnThrottle !== undefined && { retryOnThrottle: options.retryOnThrottle }),
+            ...(options.replay !== undefined && { replay: options.replay }),
+            ...(options.sdk !== undefined && { sdk: options.sdk }),
+            ...(options.jsonSchemaValidator !== undefined && {
+                jsonSchemaValidator: options.jsonSchemaValidator,
+            }),
+        },
+        now: options.now ?? Date.now,
+        open: options._open,
+    };
+}
+/** One transport for everyone, or a function of the identity — as a function either way. */
+function transportOf(value, where) {
+    if (typeof value === 'function')
+        return value;
+    if (value !== null && typeof value === 'object' && typeof value.transport === 'string') {
+        return () => value;
+    }
+    throw new TypeError(`${where}: \`transport\` must be an MCP transport ({ transport: 'http' | 'gateway' | 'stdio', … }) ` +
+        'or a function of the identity that returns one.');
+}
+/** A whole number ≥ 1, or the default when absent. */
+function positiveInteger(value, fallback, key, where) {
+    if (value === undefined)
+        return fallback;
+    if (typeof value === 'number' && Number.isInteger(value) && value >= 1)
+        return value;
+    throw new TypeError(`${where}: \`${key}\` must be a whole number ≥ 1.`);
+}
+/** A boolean, or the default when absent. */
+function flag(value, fallback, key, where) {
+    if (value === undefined)
+        return fallback;
+    if (typeof value === 'boolean')
+        return value;
+    throw new TypeError(`${where}: \`${key}\` must be true or false.`);
+}
+//# sourceMappingURL=options.js.map

package/dist/esm/mcp/pool/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../../src/mcp/pool/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAE,mBAAmB,EAAyB,MAAM,cAAc,CAAC;AA2H1E,gFAAgF;AAChF,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,EAAE;IACd,sBAAsB,EAAE,CAAC;IACzB,SAAS,EAAE,CAAC;IACZ,aAAa,EAAE,GAAG;IAClB,aAAa,EAAE,MAAM;IACrB,MAAM,EAAE,OAAO;IACf,UAAU,EAAE,OAAO;IACnB,eAAe,EAAE,OAAO;CACzB,CAAC,CAAC;AAEH,gGAAgG;AAChG,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C,0EAA0E;AAC1E,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AA8BpC;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,OAA6B;IAC3D,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QACpD,MAAM,IAAI,SAAS,CAAC,uEAAuE,CAAC,CAAC;IAC/F,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACzB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACnD,MAAM,IAAI,SAAS,CACjB,mGAAmG,CACpG,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,iBAAiB,IAAI,GAAG,CAAC;IACvC,IAAK,OAA6C,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QAC5E,MAAM,IAAI,SAAS,CACjB,GAAG,KAAK,mFAAmF;YACzF,wFAAwF;YACxF,8DAA8D,CACjE,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACxD,MAAM,KAAK,GAAG,CAAC,GAAmC,EAAU,EAAE,CAC5D,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACpE,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,YAAY,CAAC;IACxD,IAAI,WAAW,KAAK,YAAY,IAAI,OAAO,WAAW,EAAE,KAAK,KAAK,UAAU,EAAE,CAAC;QAC7E,MAAM,IAAI,SAAS,CACjB,GAAG,KAAK,uFAAuF,CAChG,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QAC3E,MAAM,IAAI,SAAS,CAAC,GAAG,KAAK,mCAAmC,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;QACnE,MAAM,IAAI,SAAS,CAAC,GAAG,KAAK,+DAA+D,CAAC,CAAC;IAC/F,CAAC;IACD,0EAA0E;IAC1E,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;QAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7E,OAAO;QACL,IAAI;QACJ,SAAS;QACT,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC;QAC/B,sBAAsB,EAAE,KAAK,CAAC,wBAAwB,CAAC;QACvD,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC;QAC7B,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC;QACrC,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC;QACrC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC;QACvB,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC;QAC/B,eAAe,EAAE,KAAK,CAAC,iBAAiB,CAAC;QACzC,KAAK,EAAE,WAAW,KAAK,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK;QACnE,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,CAAC;QACjF,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,CAAC;QACzE,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,MAAM,EAAE;YACN,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;YAC3E,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;YAC3E,GAAG,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC;YAC1F,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;YAC/D,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YACtD,GAAG,CAAC,OAAO,CAAC,mBAAmB,KAAK,SAAS,IAAI;gBAC/C,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;aACjD,CAAC;SACH;QACD,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG;QAC5B,IAAI,EAAE,OAAO,CAAC,KAAK;KACpB,CAAC;AACJ,CAAC;AAED,4FAA4F;AAC5F,SAAS,WAAW,CAClB,KAAoD,EACpD,KAAa;IAEb,IAAI,OAAO,KAAK,KAAK,UAAU;QAAE,OAAO,KAAK,CAAC;IAC9C,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QACvF,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC;IACrB,CAAC;IACD,MAAM,IAAI,SAAS,CACjB,GAAG,KAAK,4FAA4F;QAClG,iDAAiD,CACpD,CAAC;AACJ,CAAC;AAED,sDAAsD;AACtD,SAAS,eAAe,CAAC,KAAc,EAAE,QAAgB,EAAE,GAAW,EAAE,KAAa;IACnF,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACrF,MAAM,IAAI,SAAS,CAAC,GAAG,KAAK,OAAO,GAAG,gCAAgC,CAAC,CAAC;AAC1E,CAAC;AAED,6CAA6C;AAC7C,SAAS,IAAI,CAAC,KAAc,EAAE,QAAiB,EAAE,GAAW,EAAE,KAAa;IACzE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC7C,MAAM,IAAI,SAAS,CAAC,GAAG,KAAK,OAAO,GAAG,2BAA2B,CAAC,CAAC;AACrE,CAAC"}

package/dist/esm/mcp/pool/plan.d.ts

@@ -0,0 +1,77 @@
+/**
+ * plan — what one client is opened from, resolved before anything opens, and
+ * the context its tool definitions belong to.
+ *
+ * Pattern: a pure resolution step + two hashes.
+ * Role:    § 6.1–6.2 of the design. A client is opened from a PLAN: the
+ *          transport the factory returns for this identity, resolved at that
+ *          moment and kept unchanged for the client's life. The plan's
+ *          `configHash` is SHA-256 over a canonical encoding of the transport's
+ *          comparable data — the pool name; the transport kind and URL; header
+ *          names and a digest of their values; a gateway's service, scopes,
+ *          mode and credential provider id; stdio's command, args and working
+ *          directory; the transport's own stated `settings`; `resultMode` and
+ *          `clientInfo`. A function (a `fetch`, an AWS client) cannot be
+ *          compared: the app's `configuration` name covers it.
+ *
+ * The definitions CONTEXT is the binding a tool is listed under:
+ *
+ *   - per client (the default): `pc:<configHash>` — the client's own list;
+ *   - shared, when the app's `share` names both a configuration and an
+ *     authorization: `sh:<sha256(configHash, configuration, authorization,
+ *     tenant)>`. The tenant is always in it: the app's names widen sharing
+ *     across principals, never across tenants.
+ *
+ * The transport is resolved once, when a client opens; the context is not. The
+ * app's names can move — a policy version in `authorization` — so the pool asks
+ * `share` again at every listing, every call and every send gate
+ * (`contextFor`), over the client's own `configHash`: a conversation that
+ * already has a client follows a new name as a new conversation would.
+ *
+ * Neither hash leaves the process; the app's names are hashed and never kept.
+ */
+import type { ClientPort, PooledClientSeam } from '../clientPort.js';
+import type { McpClient, McpClientOptions, McpTransport } from '../types.js';
+import type { PoolKey } from './identityKey.js';
+import type { PoolSettings } from './options.js';
+/** What a client is opened from. */
+export interface ClientPlan {
+    readonly transport: McpTransport;
+    readonly configHash: string;
+    /** The definitions context: `pc:<configHash>` or `sh:<context>`. */
+    readonly context: string;
+    /** True when the app's sharing contract applies to this conversation. */
+    readonly shared: boolean;
+}
+/** An opened client: the ordinary `McpClient`, and the port back (`clientPort.ts`). */
+export interface OpenedClient {
+    readonly client: McpClient;
+    readonly port: ClientPort;
+}
+/**
+ * How the pool opens one client. The real path is `openPooledClient`; a test
+ * injects its own (the `_open` seam).
+ */
+export type PoolClientOpener = (options: McpClientOptions, seam: PooledClientSeam) => Promise<OpenedClient>;
+/**
+ * The plan for `key`: the transport the factory returns now, and the context
+ * its definitions belong to.
+ *
+ * @throws what the transport factory or `share` throws, and a TypeError when
+ *   `share` answers with anything but two names or `undefined` — the caller
+ *   refuses the open with `init-failed`, the error as its `cause`
+ */
+export declare function resolvePlan(settings: PoolSettings, key: PoolKey): ClientPlan;
+/**
+ * The definitions context `key` belongs to now, for a client opened with
+ * `configHash`: the app's `share` asked again.
+ *
+ * @throws what `share` throws, and a TypeError when it answers with anything
+ *   but two names or `undefined`
+ */
+export declare function contextFor(settings: PoolSettings, key: PoolKey, configHash: string): {
+    readonly context: string;
+    readonly shared: boolean;
+};
+/** SHA-256 over the transport's comparable data (see the module note). */
+export declare function configHashOf(settings: PoolSettings, transport: McpTransport): string;

package/dist/esm/mcp/pool/plan.js

@@ -0,0 +1,134 @@
+/**
+ * plan — what one client is opened from, resolved before anything opens, and
+ * the context its tool definitions belong to.
+ *
+ * Pattern: a pure resolution step + two hashes.
+ * Role:    § 6.1–6.2 of the design. A client is opened from a PLAN: the
+ *          transport the factory returns for this identity, resolved at that
+ *          moment and kept unchanged for the client's life. The plan's
+ *          `configHash` is SHA-256 over a canonical encoding of the transport's
+ *          comparable data — the pool name; the transport kind and URL; header
+ *          names and a digest of their values; a gateway's service, scopes,
+ *          mode and credential provider id; stdio's command, args and working
+ *          directory; the transport's own stated `settings`; `resultMode` and
+ *          `clientInfo`. A function (a `fetch`, an AWS client) cannot be
+ *          compared: the app's `configuration` name covers it.
+ *
+ * The definitions CONTEXT is the binding a tool is listed under:
+ *
+ *   - per client (the default): `pc:<configHash>` — the client's own list;
+ *   - shared, when the app's `share` names both a configuration and an
+ *     authorization: `sh:<sha256(configHash, configuration, authorization,
+ *     tenant)>`. The tenant is always in it: the app's names widen sharing
+ *     across principals, never across tenants.
+ *
+ * The transport is resolved once, when a client opens; the context is not. The
+ * app's names can move — a policy version in `authorization` — so the pool asks
+ * `share` again at every listing, every call and every send gate
+ * (`contextFor`), over the client's own `configHash`: a conversation that
+ * already has a client follows a new name as a new conversation would.
+ *
+ * Neither hash leaves the process; the app's names are hashed and never kept.
+ */
+import { canonicalJson } from '../../lib/canonicalJson.js';
+import { sha256Hex } from '../../lib/sha256.js';
+/**
+ * The plan for `key`: the transport the factory returns now, and the context
+ * its definitions belong to.
+ *
+ * @throws what the transport factory or `share` throws, and a TypeError when
+ *   `share` answers with anything but two names or `undefined` — the caller
+ *   refuses the open with `init-failed`, the error as its `cause`
+ */
+export function resolvePlan(settings, key) {
+    const transport = settings.transport(key.identity);
+    if (transport === null ||
+        typeof transport !== 'object' ||
+        typeof transport.transport !== 'string') {
+        throw new TypeError(`mcpClientPool[${settings.name}]: the \`transport\` function returned something that is not an MCP transport.`);
+    }
+    const configHash = configHashOf(settings, transport);
+    return { transport, configHash, ...contextFor(settings, key, configHash) };
+}
+/**
+ * The definitions context `key` belongs to now, for a client opened with
+ * `configHash`: the app's `share` asked again.
+ *
+ * @throws what `share` throws, and a TypeError when it answers with anything
+ *   but two names or `undefined`
+ */
+export function contextFor(settings, key, configHash) {
+    const names = shareOf(settings, key);
+    if (names === undefined)
+        return { context: `pc:${configHash}`, shared: false };
+    const context = sha256Hex(canonicalJson({
+        configHash,
+        configuration: names.configuration,
+        authorization: names.authorization,
+        tenant: key.tenant,
+    }));
+    return { context: `sh:${context}`, shared: true };
+}
+/** The app's two names for this conversation, or `undefined` for a list of its own. */
+function shareOf(settings, key) {
+    if (settings.share === undefined)
+        return undefined;
+    const names = settings.share(key.identity);
+    if (names === undefined)
+        return undefined;
+    if (names !== null &&
+        typeof names === 'object' &&
+        typeof names.configuration === 'string' &&
+        typeof names.authorization === 'string') {
+        const { configuration, authorization } = names;
+        return { configuration, authorization };
+    }
+    throw new TypeError(`mcpClientPool[${settings.name}]: \`definitions.share\` must return { configuration, authorization } ` +
+        '(two strings) or undefined, synchronously.');
+}
+/** SHA-256 over the transport's comparable data (see the module note). */
+export function configHashOf(settings, transport) {
+    return sha256Hex(canonicalJson({
+        pool: settings.name,
+        transport: comparableOf(transport),
+        resultMode: settings.client.resultMode ?? null,
+        clientInfo: settings.client.clientInfo ?? null,
+    }));
+}
+/** The comparable part of a transport: data only, functions left out. */
+function comparableOf(transport) {
+    if (transport.transport === 'stdio') {
+        return {
+            kind: 'stdio',
+            command: transport.command,
+            args: [...(transport.args ?? [])],
+            cwd: transport.cwd ?? null,
+        };
+    }
+    const headers = headersOf(transport.headers);
+    if (transport.transport === 'gateway') {
+        return {
+            kind: 'gateway',
+            url: transport.url,
+            headers,
+            service: transport.service,
+            scopes: [...(transport.scopes ?? [])],
+            mode: transport.mode ?? null,
+            credentials: transport.credentials?.id ?? null,
+        };
+    }
+    return {
+        kind: 'http',
+        url: transport.url,
+        headers,
+        settings: transport.settings ?? null,
+    };
+}
+/** Header names, and a digest of their values — never the values themselves. */
+function headersOf(headers) {
+    if (headers === undefined)
+        return { names: [], digest: null };
+    const lowered = Object.fromEntries(Object.entries(headers).map(([name, value]) => [name.toLowerCase(), value]));
+    return { names: Object.keys(lowered).sort(), digest: sha256Hex(canonicalJson(lowered)) };
+}
+//# sourceMappingURL=plan.js.map

package/dist/esm/mcp/pool/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../../../src/mcp/pool/plan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AA+BhD;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,QAAsB,EAAE,GAAY;IAC9D,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACnD,IACE,SAAS,KAAK,IAAI;QAClB,OAAO,SAAS,KAAK,QAAQ;QAC7B,OAAO,SAAS,CAAC,SAAS,KAAK,QAAQ,EACvC,CAAC;QACD,MAAM,IAAI,SAAS,CACjB,iBAAiB,QAAQ,CAAC,IAAI,gFAAgF,CAC/G,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,CAAC;AAC7E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CACxB,QAAsB,EACtB,GAAY,EACZ,UAAkB;IAElB,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACrC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC/E,MAAM,OAAO,GAAG,SAAS,CACvB,aAAa,CAAC;QACZ,UAAU;QACV,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,MAAM,EAAE,GAAG,CAAC,MAAM;KACnB,CAAC,CACH,CAAC;IACF,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AACpD,CAAC;AAED,uFAAuF;AACvF,SAAS,OAAO,CAAC,QAAsB,EAAE,GAAY;IACnD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACnD,MAAM,KAAK,GAAY,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAQ,KAA6B,CAAC,aAAa,KAAK,QAAQ;QAChE,OAAQ,KAA6B,CAAC,aAAa,KAAK,QAAQ,EAChE,CAAC;QACD,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,KAA4B,CAAC;QACtE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;IAC1C,CAAC;IACD,MAAM,IAAI,SAAS,CACjB,iBAAiB,QAAQ,CAAC,IAAI,wEAAwE;QACpG,4CAA4C,CAC/C,CAAC;AACJ,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,YAAY,CAAC,QAAsB,EAAE,SAAuB;IAC1E,OAAO,SAAS,CACd,aAAa,CAAC;QACZ,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,SAAS,EAAE,YAAY,CAAC,SAAS,CAAC;QAClC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI;QAC9C,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI;KAC/C,CAAC,CACH,CAAC;AACJ,CAAC;AAED,yEAAyE;AACzE,SAAS,YAAY,CAAC,SAAuB;IAC3C,IAAI,SAAS,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;QACpC,OAAO;YACL,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACjC,GAAG,EAAE,SAAS,CAAC,GAAG,IAAI,IAAI;SAC3B,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7C,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO;YACL,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,OAAO;YACP,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,MAAM,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;YACrC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,IAAI;YAC5B,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,EAAE,IAAI,IAAI;SAC/C,CAAC;IACJ,CAAC;IACD,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,SAAS,CAAC,GAAG;QAClB,OAAO;QACP,QAAQ,EAAE,SAAS,CAAC,QAAQ,IAAI,IAAI;KACrC,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,SAAS,SAAS,CAAC,OAAqD;IACtE,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,CAAC,CAC5E,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;AAC3F,CAAC"}