Mux TypeScript SDK

The Mux MCP server supports two execution modes for the code tool:

• Local Mode (Default): Code runs on the MCP server machine inside an isolated Deno sandbox. If Deno cannot be automatically installed, you can set the DENO_PATH environment variable to a Deno 2.9 or newer executable.
• Remote Mode: Code is sent to a remote sandbox service. This is enabled via --code-execution-mode=remote or the MCP_SERVER_CODE_EXECUTION_MODE environment variable.

When using Remote Mode, you must provide:

• CODE_SANDBOX_URL (or --code-sandbox-url): The URL of the sandbox service.
• CODE_SANDBOX_API_KEY (or --code-sandbox-api-key): The API key for the service, sent as a Bearer token.

Path parameters are now automatically encoded by default. If you were manually calling encodeURIComponent() on parameters before passing them to the SDK, you must stop doing so to avoid double-encoding.

- client.example.retrieve(encodeURIComponent('string/with/slash'))
+ client.example.retrieve('string/with/slash') // retrieves /example/string%2Fwith%2Fslash

The Mux MCP server uses a "Code Mode" tool scheme designed for agents to interact with the Mux TypeScript SDK. The server exposes two primary tools:

1. Docs Search Tool: Allows the agent to query documentation about the API/SDK.
2. Code Tool: Allows the agent to write code against the TypeScript SDK. This code is executed in an isolated sandbox without web or filesystem access. The results or logs from the execution are returned to the agent.

This allows agents to perform complex, deterministic tasks by writing and running SDK code in a controlled environment.

Mux API list methods are paginated. You can use the for await ... of syntax to automatically fetch all pages of results.

Alternatively, you can manually paginate using page.hasNextPage() and page.getNextPage().

// Option 1: Auto-pagination with for await ... of
async function fetchAllDeliveryReports(params) {
  const allDeliveryReports = [];
  for await (const deliveryReport of client.video.deliveryUsage.list()) {
    allDeliveryReports.push(deliveryReport);
  }
  return allDeliveryReports;
}

// Option 2: Manual pagination
let page = await client.video.deliveryUsage.list();
for (const deliveryReport of page.data) {
  console.log(deliveryReport);
}

while (page.hasNextPage()) {
  page = await page.getNextPage();
}

If you need to access undocumented endpoints or parameters, the library provides low-level HTTP verb methods (client.get, client.post, etc.).

• Undocumented endpoints: Use client.post('/path', { body: ... }).
• Undocumented params: Use // @ts-expect-error to bypass type checking. Extra parameters in GET requests are sent as query params; in other requests, they are sent in the body.
• Undocumented response properties: Use // @ts-expect-error or type casting to access extra fields returned by the API.

// Undocumented endpoint
await client.post('/some/path', {
  body: { some_prop: 'foo' },
  query: { some_query_arg: 'bar' },
});

// Undocumented parameter
client.video.assets.create({
  // @ts-expect-error baz is not yet public
  baz: 'undocumented option',
});

To run the server on your local machine for development:

1. Install dependencies: npm install
2. Start the development server: npm run dev

The server should be accessible at http://localhost:8787/.

To integrate the Mux MCP server into Cursor, add the configuration to your local MCP settings file.

1. Open ~/.cursor/mcp.json.
2. Add the mux server configuration using mcp-remote.

{
  "mcpServers": {
    "mux": {
      "command": "npx",
      "args": ["-y", "mcp-remote@latest", "{{cloudflareWorkerUrl}}"]
    }
  }
}

To integrate the Mux MCP server into Windsurf, add the configuration to your local MCP settings file.

1. Open ~/.codeium/windsurf/mcp_config.json.
2. Add the mux server configuration using mcp-remote.

{
  "mcpServers": {
    "mux": {
      "command": "npx",
      "args": ["-y", "mcp-remote@latest", "{{cloudflareWorkerUrl}}"]
    }
  }
}

Use the MCP Inspector to explore your API and test tools. This server implements a local version of OAuth redirects that accepts an API token and client configuration.

1. Start the inspector: npx @modelcontextprotocol/inspector.
2. In the inspector UI (usually http://localhost:5173), set the Transport Type to SSE.
3. Enter the SSE URL: http://localhost:8787/sse (or your Cloudflare workers.dev/sse URL for remote servers).
4. Click Connect.
5. When prompted by the mock login screen, enter any email and password to complete the redirect.

To use your local MCP server with Claude Desktop, you must configure Claude to use a local proxy (mcp-remote) that communicates with your server over HTTP/SSE.

1. Open your Claude Desktop configuration file (Settings > Developer > Edit Config).
2. Replace or update the configuration with the following structure, pointing to your local SSE endpoint:

{
  "mcpServers": {
    "mux": {
      "command": "npx",
      "args": ["mcp-remote", "http://localhost:8787/sse"]
    }
  }
}