MCPServerReference
MCP Server Reference Lightweight reference to pre-configured MCP servers used by workflows
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
| In webhook payloads | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
serverId | string | Required in requests | ID of pre-configured MCP server (e.g., "github", "filesystem"). Minimum length: 1. |
enabled | boolean | Optional; explicit presence | Whether to use this MCP server. Omission means enabled; only an explicitly false value excludes it from discovery. |
priority | integer (int32) | Optional | Priority override for tool selection (higher = preferred). Minimum: -2147483648. Maximum: 2147483647. |
allowlistToolPatterns | Array of string | Optional | Only include tools matching these patterns (e.g., "github_get_", "search_"). |
blocklistToolPatterns | Array of string | Optional | Exclude tools matching these patterns (e.g., "_delete", "_destroy"). |
serverOverrides | Map from string to string | Optional | Override server settings for this usage. |
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
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
serverId | string | Required in requests | ID of pre-configured MCP server (e.g., "github", "filesystem"). |
enabled | boolean | Optional; explicit presence | Whether to use this MCP server. Omission means enabled; only an explicitly false value excludes it from discovery. |
priority | integer (int32) | Optional | Priority override for tool selection (higher = preferred). Minimum: -2147483648. Maximum: 2147483647. |
allowlistToolPatterns | Array of string | Optional | Only include tools matching these patterns (e.g., "github_get_", "search_"). |
blocklistToolPatterns | Array of string | Optional | Exclude tools matching these patterns (e.g., "_delete", "_destroy"). |
serverOverrides | Map from string to string | Optional | Override server settings for this usage. |
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 webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
server_id | string | Required in requests | ID of pre-configured MCP server (e.g., "github", "filesystem"). |
enabled | boolean | Optional; explicit presence | Whether to use this MCP server. Omission means enabled; only an explicitly false value excludes it from discovery. |
priority | integer (int32) | Optional | Priority override for tool selection (higher = preferred). Minimum: -2147483648. Maximum: 2147483647. |
allowlist_tool_patterns | Array of string | Optional | Only include tools matching these patterns (e.g., "github_get_", "search_"). |
blocklist_tool_patterns | Array of string | Optional | Exclude tools matching these patterns (e.g., "_delete", "_destroy"). |
server_overrides | Map from string to string | Optional | Override server settings for this usage. |
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 |
|---|---|---|
server_id | Minimum length | 1 |
Where used
| Reference | Relationship |
|---|---|
| Create an agent profile | POST /api/v1/agent-profiles/create |
| Update an agent profile | POST /api/v1/agent-profiles/update |
| 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 |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Update conversation settings | POST /api/v1/llm/update-settings |
| 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 |
| 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 |
| 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 |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| AgentProfile | Nested in model |
| AgentProfile | Nested in model |
| ConversationSettings | Nested in model |
| ConversationSettings | Nested in model |
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-mcp-server-reference.