IntegrationDefinition schema
One external integration (MCP server or HTTP-endpoint set). An integration declares no capability envelope: the realised tools reported by the provider are the only capability source.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | no | Stable integration id. Optional in-file: falls back to the filename stem when omitted. |
displayName | string | yes | Human-readable name. |
type | enum (MCP_STDIO, MCP_STREAMABLE_HTTP, HTTP_TOOL) | yes | Integration kind: an MCP server (stdio or streamable HTTP), or a code-defined HTTP tool set. |
active | boolean | no | Whether this integration feeds capability resolution. Defaults to true when omitted. |
config | object | array | yes | Type-specific payload. MCP_STDIO: an object with required 'command' (executable only, no shell parsing) plus optional 'args' (array of strings), 'env' (object of literal string values), and 'requestTimeout' (ISO-8601 duration, default PT30S). MCP_STREAMABLE_HTTP: an object with required 'url' plus optional 'requestTimeout', 'staticHeaders' (object of literal header name to value, sent on every request) and 'secretHeaders' (object of header name to secret-reference key, resolved via SecretResolver at connect time). HTTP_TOOL: an array of HttpEndpointDefinition objects, validated against #/$defs/httpEndpoint by the conditional below. |
Definitions
httpEndpoint
One HTTP_TOOL endpoint = one capability (OSS HttpEndpointDefinition).
| Property | Type | Required | Description |
|---|---|---|---|
capability | string | yes | Logical capability id, lowercase <domain>.<verb_object>. |
displayName | string | null | no | — |
description | string | null | no | — |
mutating | boolean | yes | Whether invoking this endpoint may mutate remote state; the realised tool risk signal (recommend gating a mutating endpoint with REQUIRE_APPROVAL). |
method | enum (GET, POST, PUT, PATCH, DELETE, HEAD) | yes | — |
urlTemplate | string | yes | Absolute http/https URL with {name} placeholders. |
inputSchema | object | yes | JSON Schema for the tool arguments; non-null. |
outputSchema | object | null | no | — |
queryArgs | array of string | no | — |
bodyMode | enum (NONE, JSON) | yes | — |
staticHeaders | object | no | — |
secretHeaders | object | no | Header name to secret-reference key, resolved at invoke. |
timeout | string | null | no | ISO-8601 duration (e.g. PT30S), or null for the provider default. |
maxRetries | integer | null | no | Retry budget, or null for unset. |
retryNonIdempotent | boolean | no | — |
maxResponseBytes | integer | null | no | — |