Skip to main content
Creates an MCP Box that serves an MCP Box Snapshot’s tools over MCP in front of an API Box, and starts it. The API Box must be in the workspace and started from the API Box Snapshot the MCP Box Snapshot was built against. It returns at once with status starting and the MCP Box’s token; get the MCP Box until it is running. Send MCP requests to its endpoint followed by /mcp, with the token in X-Continuous-Token. The MCP Box keeps no state: its tools read and change the API Box, and a tool call while the API Box is stopped returns the API Box’s refusal as a tool error.

Examples

Flags

string
required
An API Box of the workspace, started from the API Box Snapshot the MCP Box Snapshot was built against.
string
Request body as JSON (alternative to individual flags). Can also be provided via stdin.
string
Optional key for retrying this create safely. A retry with the same key and request returns the same MCP Box and token. The same key with a different request returns 409 idempotency_conflict.
string
Customer JSON metadata, up to 16 KiB and 64 nesting levels.
string
Name for the MCP Box. Omission generates a name.
string
required
A ready MCP Box Snapshot of the workspace or the catalog.
Global flags apply to every command. See Global flags.