Skip to content

McpConnectorCreateRequest

Creates a connector to a tool on an MCP (Model Context Protocol) server.

Kind: an object, used in requests.

FieldTypeRequiredDescription
destructiveHintboolean | nullThe MCP tool annotation destructiveHint: whether the tool may destroy or overwrite data.
idempotentHintboolean | nullThe MCP tool annotation idempotentHint: whether repeating a call with the same arguments has no further effect.
openWorldHintboolean | nullThe MCP tool annotation openWorldHint: whether the tool reaches systems outside the server.
readOnlyHintboolean | nullThe MCP tool annotation readOnlyHint: whether the tool only reads and changes nothing.
namestringyesThe connector’s name, unique within its namespace (under 150 characters). Constraints: maxLength: 150, required (empty or whitespace-only strings are rejected).
urlstringyesThe endpoint’s URL. For an HTTP connector, {name} in it marks a path parameter; for an MCP connector, it is the MCP server’s URL. Constraints: format: url, required (empty or whitespace-only strings are rejected).
descriptionstringyesWhat the endpoint does, in a sentence (under 500 characters). Constraints: maxLength: 500, required (empty or whitespace-only strings are rejected).
requestSchemaJsonstring | nullThe JSON Schema of the request body, as text. The model’s arguments are checked against it before a call is made. Omitted: no body is sent.
responseSchemaJsonstring | nullThe JSON Schema the endpoint’s response must match, as text. Omitted: the response is not checked.
authenticationTypeConnectorAuthenticationTypeyesThe kind of credential the endpoint needs. The credential itself is given where a tool uses the connector. Constraints: required (empty or whitespace-only strings are rejected).
postProcessResponseUnicodeCharactersbooleanWhether to replace typographic characters in the response (curly quotes, dashes, bullets, the ellipsis) with plain ones before it is read. Defaults to false.
{
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": false,
"readOnlyHint": false,
"name": "...",
"url": "...",
"description": "...",
"requestSchemaJson": "...",
"responseSchemaJson": "...",
"authenticationType": "None",
"postProcessResponseUnicodeCharacters": false
}