Skip to main content
POST
Create Mcp Server

Authorizations

X-Session-API-Key
string
header
required

Path Parameters

settings_key
string
required

Body

application/json

One MCP server in the settings DataModel.

args
string[] | null
auth
MCPNoneAuthCredential · object
command
string | null
Minimum string length: 1
cwd
string | null
description
string | null
enabled
boolean
default:true

Whether this server is exposed to the agent. A disabled server stays fully configured -- including its secrets -- but is skipped when MCP tools are created and when servers are forwarded to an ACP subprocess.

env
Env · object | null
headers
Headers · object | null
icon
string | null
keep_alive
boolean | null
sse_read_timeout
number | null
timeout
number | null
transport
enum<string> | null
Available options:
stdio,
http,
sse,
streamable-http
url
string | null
Minimum string length: 1

Response

Successful Response

Response model for GET /api/settings.

Contains the full settings payload including agent configuration, conversation settings, active LLM profile, miscellaneous frontend-owned settings, and a flag indicating whether an LLM API key is set.

The agent_settings and conversation_settings fields are raw dicts because the server controls secret serialization via context. Use the typed accessor methods for validation:

Example::

misc_settings is an opaque container for frontend-owned data that the agent-server persists but does not interpret — see the docstring of :class:PersistedSettings.misc_settings.

agent_settings
_AgentSettingsContract · object
required
conversation_settings
Conversation Settings · object
required
llm_api_key_is_set
boolean
required
active_agent_profile_id
string | null

Stable id of the currently active AgentProfile, if one is set.

active_meta_profile
string | null

Name of the currently active meta-profile, if one is selected.

active_profile
string | null

Name of the currently active LLM profile, if one is selected.

misc_settings
Misc Settings · object