Skip to main content
POST
Start an MCP OAuth install probe

Authorizations

X-Session-API-Key
string
header
required

Body

application/json

Body for POST /api/mcp/test.

server
_StdioMCPServerSpec · object
required

Legacy stdio MCP server spec accepted by the public REST API.

name
string
default:test-server

Name to use for the server inside the temporary MCP server map. Only affects error messages -- does not need to match any persisted setting.

Required string length: 1 - 128
timeout
number
default:15

Seconds to wait for connection + tools/list to complete.

Required range: x <= 120
tool_call
MCPToolCallSpec · object | null

Optional read-only tool to invoke after listing succeeds, so callers can verify credentials the server only exercises on tool invocation. Its outcome is reported verbatim in tool_result without affecting ok.

Response

Successful Response

Response for starting an install-time OAuth MCP probe.

ok
boolean
required
authorization_url
string | null
error
string | null
error_kind
enum<string> | null
Available options:
timeout,
connection,
unknown
job_id
string | null