SDK reference - AgentMuxer

The SDK exports three framework-specific helpers. Each reads AGENTMUXER_API_KEY unless you pass apiKey. All connect to https://mcp.agentmuxer.com/mcp.

string

Your application key, supplied from a server-side secret store. Omit it to use AGENTMUXER_API_KEY. Empty values, surrounding whitespace, and non-printable characters are rejected. Browser use is rejected.

OpenAI Agents
Claude Agent SDK
Vercel AI SDK

import { agentmuxer } from "@agentmuxer/sdk/openai";

const tool = agentmuxer({
  allowedTools: [
    "search_offerings",
    "inspect_offering",
    "call_offering",
    "report_outcome",
  ],
  requireApproval: "never",
});

Returns the framework’s hosted MCP tool configuration. Add it to tools on an OpenAI agent. OpenAI receives the application key and connects to AgentMuxer.

string[] | { toolNames?: string[] }

Optional tool-name filter. The example exposes all four tools, including purchases. Omit this option to expose every tool the server provides; narrow the list when your application needs fewer tools.

"always" | "never"

default:"never"

OpenAI tool approval policy. With "always", handle approval interruptions and resume the run using OpenAI’s API. AgentMuxer payment confirmation and spending limits still apply.

Runnable OpenAI example · OpenAI MCP options

import { agentmuxer } from "@agentmuxer/sdk/claude-agent";

const server = agentmuxer({
  tools: [{ name: "search_offerings", permission_policy: "always_allow" }],
  timeout: 60_000,
  alwaysLoad: true,
});
// Pass under options.mcpServers.agentmuxer.

Returns an HTTP MCP server configuration with bearer authentication.

McpServerToolPolicy[]

Each entry identifies a tool by name. Set permission_policy to "always_allow", "always_ask", or "always_deny". The example preapproves search; unlisted tools retain their normal permissions. This option does not hide tools.

number

Optional per-tool-call timeout in milliseconds. Claude ignores values below 1,000 ms. The helper does not override the framework default.

boolean

Set true to include this server’s tools in the model context immediately instead of deferring them to Claude’s tool search. Omit it to keep the framework default.

Configure allowedTools, disallowedTools, and canUseTool on your Claude agent, not on this helper. Preapproving a framework tool does not bypass AgentMuxer’s payment policy.Runnable Claude example · Claude MCP guide

import { agentmuxer } from "@agentmuxer/sdk/ai-sdk";

const mux = await agentmuxer({
  initializationOptions: { timeout: 10_000 },
});
// Pass mux.tools to your agent; await mux.close() after it finishes.

Returns a promise for a connection. Automatic MCP tool-call retries are disabled.

{ signal?: AbortSignal; timeout?: number; maxTotalTimeout?: number }

Optional connection-initialization controls accepted by @ai-sdk/mcp. Timeouts are in milliseconds. These options do not set a purchase budget or a timeout for later tool calls.

(error: unknown) => void

Optional callback for uncaught MCP client errors. Use it to report connection failures to your application. Redact credentials and sensitive tool data before logging errors.

tool set

The discovered AgentMuxer tools, including purchases. Pass to your agent’s tools.

() => Promise<void>

Release the connection after the complete result or stream is consumed. Call in finally; HTTP streams also need cleanup on completion, error, and cancellation.

Runnable Vercel example · Vercel MCP guide

Controls outside the helper

Choose models, prompts, turn limits, and framework permissions in your agent framework. Configure balance, application spending limits, and account payment confirmation in AgentMuxer. The helpers do not add an SDK-wide dollar budget, change your account settings, or supply model-provider credentials.

Billing, limits, and approvals

Understand which controls enforce spending and which guide agent behavior.

​Controls outside the helper

Billing, limits, and approvals

Controls outside the helper