Skip to main content

Create an MCP Server Definition

Creates a new MCP server definition under the given app.

Path Parameters
appId string REQUIRED
Request Body REQUIRED
name string

Display name of the MCP server definition.

description string

Description of the MCP server definition.

documentationURL string

URL of human-readable documentation for this MCP server.

transportProtocol string

Possible values: [STDIO, STREAMABLE_HTTP, HTTP_SSE]

Transport protocol: STDIO, STREAMABLE_HTTP, or HTTP_SSE. Determines which of the transport-specific fields below are required.

externalProviderUrl string

URL of the external MCP provider. Required for STREAMABLE_HTTP and HTTP_SSE transports; ignored for STDIO.

headers object[]

HTTP headers to send to the external provider. Used for STREAMABLE_HTTP / HTTP_SSE transports.

key string
value string
id string
metadata string
stdioCommand string

Command to invoke the STDIO MCP server. Required for STDIO transport; ignored otherwise.

stdioCommandArgs string

Argument string passed to stdioCommand.

stdioEnv object[]

Environment variables for the STDIO process.

key string
value string
id string
metadata string
hasStaticTools boolean

Whether this server publishes a static set of tools. Defaults to true if omitted.

hasDynamicTools boolean

Whether this server may dynamically expose additional tools. Defaults to false if omitted.

permittedAuthMechanisms string[]

Auth mechanism IDs (from the parent app's authMechanisms) permitted on this MCP server.

Responses
200

Returns the newly created MCP server definition

Schema OPTIONAL
object