Skip to content
Kindgi

Fetch an MCP endpoint

View as Markdown
GET
/v1/mcp/endpoints/{endpointId}
curl --request GET \
  --url https://example.com/v1/mcp/endpoints/example \
  --header 'Authorization: Bearer <token>'

Returns the wire-safe MCPEndpoint (secrets never cross the wire — secretRef, auth and secretEnv name secrets the runtime resolves inside the deployment). A stdio endpoint’s config.env values read back as [redacted], their names kept.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
endpointId
required
string
>= 1 characters

MCPEndpointId — deployment-stable string identifier chosen by the caller.

Responses

Section titled “Responses”

200

Section titled “200”

MCP endpoint.

Media typeapplication/json
object
endpointId
required
string
>= 1 characters
name
required

Human-readable display name.

string
>= 1 characters
transport
required

MCP transport variant. stdio — local subprocess (spawn a command). http-sse — the older MCP HTTP+SSE transport (separate POST + SSE endpoints). streamable-http — the Streamable HTTP transport (single endpoint, session id via header).

string
Allowed values: stdio http-sse streamable-http
config
required
One of:
object
transport
required
Allowed value: stdio
command
required
string
>= 1 characters
args
Array<string>
env

Variables for the server’s process, stored as given. Not for a credential: a name config.headers would refuse, its parts split on _ as well as - (GITHUB_TOKEN, OPENAI_API_KEY, AWS_SECRET_ACCESS_KEY, SLACK_BOT_TOKEN), is refused (invalid-mcp-endpoint, reason credential-in-env). Give it by reference through secretEnv. An empty name, a name with = or a NUL, a value with a NUL, or a value of [redacted] is refused too (reason invalid-stdio-env). Every value reads back as [redacted], its name kept, on endpoints registered before as well, so an export holds the names, not the values.

object
key
additional properties
string
secretRef

The secret sent as the endpoint’s bearer. HTTP transports only: on a stdio endpoint it’s refused (invalid-mcp-endpoint, reason secret-ref-on-stdio), since a stdio server gets no headers; give it its secret through secretEnv. An endpoint registered with one before keeps it, and the runtime reads it for no one.

object
envName
required
string
/^[a-z][a-z0-9-]{0,62}$/
name
required
string
>= 1 characters <= 256 characters
auth
One of: discriminator: scheme

HTTP Basic: the runtime sends Authorization: Basic base64(<username>:<secret>), with the secret secretRef names (a WordPress Application Password, for one).

object
scheme
required
Allowed value: basic
username
required

The user name. Not a secret, and without :.

string
>= 1 characters <= 256 characters /^[^:]+$/
secretRef
required

The secret an MCP endpoint authenticates with: a name in the deployment’s secrets store, resolved at the endpoint’s tenant scope by the runtime (the shape webhooks and providers use). As the endpoint’s own secretRef, it is sent as its bearer; inside auth, it is the scheme’s password, client secret or header value; in secretEnv, a variable’s value for a stdio server. The endpoint keeps only this reference.

object
envName
required
string
/^[a-z][a-z0-9-]{0,62}$/
name
required
string
>= 1 characters <= 256 characters
secretEnv

A stdio server’s secrets, as variables of its process: each variable’s name (GITHUB_TOKEN) with the secret its value is read from, at the endpoint’s recorded scope, when the runtime starts the server. The value is never stored or answered. 1 to 16 variables, each name without =, and none also in config.env (invalid-mcp-endpoint, reason secret-env-twice); otherwise reason invalid-secret-env. Each secret counts for the provider-key guard and the env a runtime serves, as secretRef’s does. stdio only: on an HTTP endpoint it’s refused (reason secret-env-on-http). An older runtime refuses the field as unknown. A runtime rolled back to one without it starts the server without these variables, so the server fails its own calls; no value is exposed.

object
>= 1 properties <= 16 properties
key
additional properties

The secret an MCP endpoint authenticates with: a name in the deployment’s secrets store, resolved at the endpoint’s tenant scope by the runtime (the shape webhooks and providers use). As the endpoint’s own secretRef, it is sent as its bearer; inside auth, it is the scheme’s password, client secret or header value; in secretEnv, a variable’s value for a stdio server. The endpoint keeps only this reference.

object
envName
required
string
/^[a-z][a-z0-9-]{0,62}$/
name
required
string
>= 1 characters <= 256 characters
instructions

Optional pass-through to the MCP client serverInfo.instructions.

string
metadata

Optional caller-defined metadata bag.

object
key
additional properties
any
sendTraceparent

Send the W3C traceparent of the run calling a tool to this endpoint, as a request header, so the server’s logs can be matched to the run. Ids only, never content. Default false. HTTP transports only: true on a stdio endpoint is refused (invalid-mcp-endpoint, reason invalid-send-traceparent). An older runtime ignores it and sends none.

boolean
secretScopes

Where each secret it names is read, by name: recorded by the server when it was registered, never sent by a caller. null: none usable (the registrant administers no scope the secret could be read at), until an admin records it again: a tool by publishing a new version, an MCP endpoint by unregistering it and registering it again. Absent on items registered before it was recorded, or on a runtime without a secrets store.

object
key
additional properties
One of:
One of:
object
kind
required
string
Allowed value: tenant
Example
{
  "transport": "stdio",
  "config": {
    "transport": "stdio"
  },
  "auth": {
    "scheme": "basic"
  },
  "secretScopes": {
    "additionalProperty": {
      "kind": "tenant"
    }
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No MCP endpoint with that id under this workspace.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also