Skip to main content
POST
Render an MCP App widget headlessly

Authorizations

Authorization
string
header
required

MCPJam API key (sk_…). Create one at Settings → API keys. Guest sessions cannot use the API, and API keys cannot manage other API keys.

Path Parameters

projectId
string
required

ID of the hosted project that contains the server.

serverId
string
required

ID of the server inside the project.

Body

application/json
toolName
string
required

The MCP App tool to render. A tool that declares no ui:// UI resource is refused (422) rather than run.

parameters
object
includeSnapshot
boolean
default:true

Return the widget as an accessibility tree with addressable elements. Default true — the reverse of the local Inspector route, because this endpoint's caller is usually a model for which a base64 image is the most expensive way to say nothing.

includeScreenshot
boolean
default:false

Also return a base64 image. Default false: it is by far the largest field this returns.

injectOpenAiCompat
boolean

Mount with the OpenAI Apps compatibility shims instead of the spec-default MCP-UI bridge.

viewport
object

Response

The render verdict and its evidence.

status
string
required

The render verdict, e.g. rendered.

resourceUri
string
bridgeInitialized
boolean
consoleErrors
string[]
blockedRequests
string[]

Requests the render sandbox refused. A widget that renders while every fetch is blocked photographs perfectly and is broken, so this is reported even on a success.

snapshot
object
screenshot
object

Present only when includeScreenshot was explicitly requested.

timings
object