Section ID:
Section ID:
DOC-API-MODEL-schema-1hik90rmo1#overview
MCPServerReference
MCP Server Reference Lightweight reference to pre-configured MCP servers used by workflows
Type-reference view: API Schema 9frhv4euve, API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1hik90rmo1#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1hik90rmo1#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-field-serveridserverId | string | Required in requests | ID of pre-configured MCP server (e.g., "github", "filesystem"). Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-field-enabledenabled | boolean | Optional; explicit presence | Whether to use this MCP server. Omission means enabled; only an explicitly false value excludes it from discovery. |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-field-prioritypriority | string (int64) | Optional | Priority override for tool selection (higher = preferred). Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-field-allowlisttoolpatternsallowlistToolPatterns | Array of string | Optional | Only include tools matching these patterns (e.g., "github_get_", "search_"). |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-field-blocklisttoolpatternsblocklistToolPatterns | Array of string | Optional | Exclude tools matching these patterns (e.g., "_delete", "_destroy"). |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-field-serveroverridesserverOverrides | Map from string to string | Optional | Override server settings for this usage. |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-field-defertoolsdeferTools | boolean | Optional | Whether this server's tools are deferred. A deferred tool is left out of the model's tool list until the run's tool search loads it. Omission or false declares every tool up front. |
Request validation
Section ID: DOC-API-MODEL-schema-1hik90rmo1#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
serverId | Minimum length | 1 |
In responses
Section ID: DOC-API-MODEL-schema-1hik90rmo1#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1hik90rmo1#field-serveridSection ID: DOC-API-MODEL-schema-1hik90rmo1#response-field-serveridserverId | string | Required in requests | ID of pre-configured MCP server (e.g., "github", "filesystem"). |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#field-enabledSection ID: DOC-API-MODEL-schema-1hik90rmo1#response-field-enabledenabled | boolean | Optional; explicit presence | Whether to use this MCP server. Omission means enabled; only an explicitly false value excludes it from discovery. |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#field-prioritySection ID: DOC-API-MODEL-schema-1hik90rmo1#response-field-prioritypriority | string (int64) | Optional | Priority override for tool selection (higher = preferred). Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#field-allowlisttoolpatternsSection ID: DOC-API-MODEL-schema-1hik90rmo1#response-field-allowlisttoolpatternsallowlistToolPatterns | Array of string | Optional | Only include tools matching these patterns (e.g., "github_get_", "search_"). |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#field-blocklisttoolpatternsSection ID: DOC-API-MODEL-schema-1hik90rmo1#response-field-blocklisttoolpatternsblocklistToolPatterns | Array of string | Optional | Exclude tools matching these patterns (e.g., "_delete", "_destroy"). |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#field-serveroverridesSection ID: DOC-API-MODEL-schema-1hik90rmo1#response-field-serveroverridesserverOverrides | Map from string to string | Optional | Override server settings for this usage. |
Section ID: DOC-API-MODEL-schema-1hik90rmo1#field-defertoolsSection ID: DOC-API-MODEL-schema-1hik90rmo1#response-field-defertoolsdeferTools | boolean | Optional | Whether this server's tools are deferred. A deferred tool is left out of the model's tool list until the run's tool search loads it. Omission or false declares every tool up front. |
DOC-API-MODEL-schema-1hik90rmo1#validation
Request validation
Section ID: DOC-API-MODEL-schema-1hik90rmo1#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
serverId | Minimum length | 1 |
Where used
Section ID: DOC-API-MODEL-schema-1hik90rmo1#where-used
| Reference | Relationship |
|---|---|
| Create an agent profile | POST /api/v1/agent-profiles/create |
| Get an agent profile | POST /api/v1/agent-profiles/get |
| Import a prompt library | POST /api/v1/agent-profiles/import |
| List agent profiles | POST /api/v1/agent-profiles/list |
| Update an agent profile | POST /api/v1/agent-profiles/update |
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Update prompt variables | POST /api/v1/llm/update-prompt-variables |
| Update conversation settings | POST /api/v1/llm/update-settings |
| Append a message without generating | POST /api/v1/llm/append-message |
| Create a new conversation thread | POST /api/v1/llm/create-thread |
| List available MCP tools | POST /api/v1/llm/mcp-list-tools |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Models containing this value
| Model | Relationship |
|---|---|
| AgentProfile | Nested in model |
| AgentProfile | Nested in model |
| ConversationSettings | Nested in model |
| ConversationSettings | Nested in model |
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1hik90rmo1