Skip to main content
PATCH
Turn an MCP server on or off

Authorizations

X-Api-Key
string
header
required

Personal or workspace LangSmith API key. Personal keys identify the user. Workspace keys are limited to server listing and MCP calls and must also supply the end user's OIDC token or X-LangSmith-Identity.

X-Tenant-Id
string
header
required

Workspace UUID. This header selects a workspace; it does not authenticate the caller.

Path Parameters

id
string
required

Server ID, or a built-in server's key

Body

application/json

Changes to a registered MCP server.

enabled
boolean
required

Whether workspace members can use the server.

Response

OK

An MCP server or built-in integration available to the workspace.

connected
boolean

Whether the current user's upstream credential is currently usable. Public servers are always connected.

connection
object

Authentication the upstream server requires from each user.

credential_source
enum<string>

Whose credential calls to the server use: workspace when a workspace admin stored one for every caller, caller when the current user's own credential is used, and none otherwise. Omitted where credential state is not reported.

Available options:
workspace,
caller,
none
credential_status
enum<string>

The current user's credential state. connected matches Connected; unavailable means the state could not be checked, not that the user must connect.

Available options:
connected,
needs_connect,
needs_reconnect,
unavailable
enabled
boolean

Whether workspace members can use the server. A workspace admin can turn a server off for the whole workspace.

has_credential
boolean

Whether the current user has stored a credential. The credential may still require renewal or correction.

icon_dark_url
string

HTTPS URL of a drawing of the icon for dark backgrounds, set only when there is one: a built-in logo that does not read on a dark background, or an icon a registered server marks as designed for a dark theme.

icon_url
string

HTTPS URL of the server's icon, for an image element. For a built-in it is the LangSmith logo; for a registered server it is the icon the server advertises, on the server's own domain. Omitted when there is none, or the server has not been reached yet.

id
string

Registered server UUID, or the integration key for a built-in.

key
string

Stable built-in integration key. Empty for registered servers.

name
string

MCP server or built-in name.

Example:

"Linear"

owned_by
object

The member who owns a personal server. Set only when a workspace admin lists every member's personal servers with owned_by=any.

owner
enum<string>

Whether the server is a LangSmith built-in or registered by the workspace.

Available options:
langsmith,
workspace
scope
enum<string>

Who can see a registered server: the whole workspace, or only the user who registered it. Empty for built-ins.

Available options:
personal,
workspace
tools
object[]

Known tools for built-in integrations.

upstream_url
string

Registered upstream MCP server URL.

url
string

Tool Gateway MCP endpoint that clients connect to.