Skip to main content
Glama

Bind an MCP server

bind_mcp_server
DestructiveIdempotent

Create or update the binding for a server the repository declares. roles is the full set of pipeline roles that may use it (reviewer and qa only ever receive read-only tools, and cannot use a server that runs inside the sandbox). transport: 'remote' (the gateway proxies to the server's URL), 'isolate' (the gateway runs the server's npm package in isolation, for a command that needs a secret) or 'local' (the command runs inside the sandbox, no credential). Omit transport and remoteUrl on an update to keep the server the binding is pinned to, with its credential (a roles, tools or credential edit); set them only to bind or re-point the server. Requires the config:write capability.

Input Schema

NameRequiredDescriptionDefault
rolesYesEvery role that may use the server ([] disables it)
projectIdYesProject id, e.g. from list_projects
remoteUrlNoA fixed https URL: a hosted endpoint for a command server, or an override for a URL server
transportNoHow the gateway reaches the server: 'remote' proxies to remoteUrl, 'isolate' runs the server's npm package away from the sandbox so a secret stays out of it, and 'local' runs the command inside the sandbox with no credential. Omit it on an update to keep the server the binding is pinned to.
credentialNoWrite-only credential the gateway attaches; agents never receive it. Omit to keep the stored one. OAuth credentials are not set here: bind as remote with kind 'none', then start_mcp_server_oauth.
serverNameYesServer name as the repository's MCP file declares it (see list_mcp_servers)
approvedToolsNoThe approved subset of the tool snapshot (refresh_mcp_server_tools first). Omit to keep it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / transport / description
      Added value: +"How the gateway reaches the server: 'remote' proxies to remoteUrl, 'isolate' runs the server's npm package away from the sandbox so a secret stays out of it, and 'local' runs the command inside the sandbox with no credential. Omit it on an update to keep the server the binding is pinned to."
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Adds real context beyond the annotations: credential is write-only and never seen by agents, reviewer/qa only ever receive read-only tools and cannot use sandbox-internal servers, and omitting fields preserves existing state while setting them re-points. It stops short of saying what happens to the previously stored credential on re-point or how failures (bad transport/credential combo) surface, which is why it isn't a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single dense paragraph with no filler; the binding/update distinction is front-loaded and the transport and field-omission rules follow in a logical order. Every clause carries actionable information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter mutation tool with no output schema, the description covers purpose, prerequisites, transport selection, and update semantics — enough to call it correctly. Gaps are minor: it does not touch approvedTools or the refresh_mcp_server_tools prerequisite, though the schema covers those.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3, but the description adds semantics the schema lacks: the role-scoping rule for reviewer/qa, the intent behind each transport mode, and the keep-vs-replace behavior of transport/remoteUrl on update. It says nothing about approvedTools (left entirely to the schema).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb pairing ('Create or update') and a precise resource ('the binding for a server the repository declares'), which cleanly separates it from list_mcp_bindings and unbind_mcp_server. An agent can identify it as the write-side counterpart to the read siblings without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit conditional guidance: omit transport/remoteUrl on an update to keep the pinned server and credential, set them only to bind or re-point. It also enumerates the three transport choices with the situation each serves (secret needed, no credential, proxied URL) and names the config:write capability prerequisite.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.