Skip to main content
This page describes @agentmuxer/sdk 0.6.x.

Runtime support

TypeScript projects that compile to CommonJS need TypeScript 5.8 or later with "module": "nodenext". The @agentmuxer/cli command also runs on Node.js 22.18 or later. For Claude Agent SDK, also check its hosting requirements.

Framework dependencies

The direct client (new AgentMuxer()) and the Admin client (new AgentMuxerAdmin()) need no framework packages. For a framework adapter, install only the dependencies for your integration. The package declares these optional peer ranges: Each release is tested against these ranges. Each integration guide includes all packages needed to run its example.

Approvals and connection behavior

Framework approval is separate from AgentMuxer’s payment confirmation. When an application requires a person to confirm purchases, the Vercel AI SDK helper with confirmation: "manual" pauses the purchase and resumes it on a later authenticated request. See the SDK README for the flow. See billing and approvals for unattended runs. The SDK never changes your account’s confirmation setting.

Other integrations

Native MCP recipes cover frameworks and hosted connectors that accept remote MCP configuration. These are separate from the three SDK adapters above. Follow each client’s requirements for authentication, approvals, and connection cleanup. For personal-agent setup, use Connect your agent.

Upgrading

1

Read the changelog

Review release notes before upgrading, especially between minor versions during 0.x.
2

Check your dependencies

Confirm that your runtime and framework versions satisfy the new package’s requirements.
3

Run your integration

Verify authentication, tool execution, approval behavior, and cleanup in your application’s environment before rollout.
The client is a class. Replace createClient() with new AgentMuxer() from @agentmuxer/sdk, and createAdminClient() with new AgentMuxerAdmin() from @agentmuxer/sdk/admin. Methods take (input, options?), so pass an abort signal as { signal }. Add a default branch to exhaustive switch statements over refusal reasons, and rename the adapters’ AgentMuxerOptions types to OpenAIAgentsOptions, ClaudeAgentOptions, and AISDKOptions. Follow Upgrading from 0.5 in the SDK README for the full table.
Since 0.2.1, the Vercel AI SDK adapter uses the ai and @modelcontextprotocol/client packages. Replace @ai-sdk/mcp with them in your dependencies:
Transport errors use the MCP client’s error classes, and each tool call allows 100 seconds.
The agentmuxer command moved to @agentmuxer/cli in 0.3.0. Run npm uninstall -g @agentmuxer/sdk before installing the CLI globally.
During 0.x, minor releases may include breaking changes or new features. Patch releases contain backward-compatible fixes. SDK versions are independent of MCP protocol versions.