Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Path Parameters

agent_id
string
required

ID of the agent. Also accepts the reserved aliases gumball and analytics.

server_id
string
required

ID of the MCP server from the caller's catalog.

Body

application/json

Connector settings for PUT /agents/{agent_id}/mcp-servers/{server_id}. Identity comes from the path; unknown keys are dropped.

credentials_to_use
object
credential_mode
enum<string>
Available options:
end_user,
agent_owned
approval_mode
enum<string>
Available options:
inherit,
off,
all,
write,
custom
tool_approval_modes
object
restricted_tools
string[]
is_incognito
boolean
is_disabled
boolean

Response

The attached (or updated) MCP server.

agent_id
string
Example:

"abc123DEFghiJKL"

mcp_server
object

The resulting connector entry, with secrets and server URL redacted.

created
boolean

true if the server was newly attached; false if an existing attachment was updated.

Example:

true

auth_status
string | null

Catalog authentication status for the server (e.g. whether OAuth has been completed).

Example:

"authenticated"

version
integer | null

The agent's configuration version after this change.