Skip to main content
Version: 3.6.0

Deploy MCP servers

An MCP deployment is an MCP server that the platform runs for you, from an entry in the MCP catalog. Its tools join the shared catalog described in Tools and Agents, like the tools of a connected MCP server.

Access​

  • In a tenant: Editors and Owners deploy MCP servers. Whoever deploys an MCP server becomes its administrator. Owners can also see and manage every MCP deployment in the tenant. See Roles in a tenant.
  • On the platform: Deploying needs permission to manage MCP infrastructure, the same permission that manages the catalog. Managing platform deployments after that needs permission to manage external MCP servers.
  • API keys: A key can use a deployment's tools when it has an MCP Deployment grant for it. You can grant only a deployment that you can use. See API keys.

Deploy an MCP server​

  1. Open MCP Servers, then Catalog, and select an entry.
  2. Select Deploy.
  3. Enter a Display name. The platform derives the tool name from it, and the name must be unique.
  4. Fill in Configuration and Secrets. Fields marked * are required. Leave an optional field blank to use the default that the catalog entry declares.
  5. Select Deploy.

The platform stores secret values and never shows them again.

A platform deployment starts shared with no tenant. See Share a deployment.

Find your deployments​

The MCP deployments section of the MCP Servers page lists the deployments that you can see, with their catalog entry, owner and state. In a tenant, the list also contains the platform deployments shared with that tenant, with Platform as the owner. Select a name to open the deployment.

StateMeaning
StartingThe server is starting. Its tools are not available yet.
RunningThe server runs, and its tools are available.
Applying changesThe server restarts with a new configuration or definition.
StoppedThe server does not run. It keeps its configuration and grants.
ErrorThe server cannot start. Check its image and configuration.
DeletingThe platform is removing the server.

Two more badges tell you that the deployment is behind its catalog entry:

  • Needs input: The catalog entry now asks for an input that this deployment has no value for. The deployment keeps running the definition it was deployed with. Its page lists the inputs that need a value.
  • Outdated: The platform could not move the deployment to the entry's current definition. The next save of the catalog entry tries again.

Open a deployment​

The deployment page shows:

  • Tool name: Tools reach the model as the tool name, followed by __ and the tool, such as grafana__search_dashboards. Select the copy button to copy the tool name.
  • Definition version: The version of the catalog entry that the deployment runs.
  • Settings: The configuration values and the names of the stored secrets. Secret values are never shown. Only platform administrators can see the settings of a platform deployment.

Configure a deployment​

Administrators of a deployment select Configure to change its display name, configuration and secrets. The tool name does not change. You do not need access to the catalog entry.

The form uses the inputs of the entry's current definition:

  • Configuration: A field opens with the value that the deployment stores. A field without a stored value is blank and shows the default that it uses, for example Default: 10. A true or false setting offers Use default (true) or Use default (false). Clear a field to go back to the default. A required setting with a default can stay blank.
  • Secrets: The platform never shows a stored secret, so every secret field opens blank. Leave a field blank to keep the stored value, or enter a new value to replace it. A required secret that the deployment has no value for must be filled in.

If the deployment needs input or is outdated, the form says that saving moves it to the entry's current definition. Fill in the inputs that the form marks as required.

If another change to the deployment wins while you save, the portal says that nothing was saved. Select Save again. A deployment that is being deleted cannot be configured.

Stop, start and delete​

  • Stop: The server stops, and its tools stop working. The deployment keeps its configuration and grants. Select Start to run it again.
  • Delete: The server and its configuration, secrets and grants are removed. You cannot undo this.

Deleting a catalog entry deletes every deployment created from it. See Delete an entry.

Share a deployment​

  • Platform deployment: The Access section controls which tenants can use the deployment's tools. Turn on Share with all tenants, or select tenants in Shared with tenants, then select Save access.
  • Tenant deployment: The Users tab controls who in the tenant can use it. Administrators can use, configure and delete the deployment. Users can use its tools.

Removing a tenant's access to the catalog entry does not stop or change the deployments made from it.

Troubleshooting​

The deployment runs, but its tools are missing​

Some MCP servers accept requests only for host names on an allow list. Such a server refuses the platform's requests with HTTP 403. The catalog entry must allow every host name. See Host name checks.

The deployment shows Error​

Check the image and the configuration values. On most clusters, the image must set a numeric non-root user, so an image that runs as root or as a named user does not start.

On OpenShift, the cluster sets the user, so the user in the image is not the cause. Check that group 0 can read the files the server reads and write the folders it writes. See Container requirements.