Skip to main content

Add a custom API or MCP server

When a service isn't in the catalog, define it yourself: its address and how it signs in. That is a custom connector. Everyone in your organization then finds it as a card under Add secret and connects with their own key or sign-in.

Who can do this: defining, changing or deleting a connector needs an Org Owner or Admin. Any member can connect to one.

Define the connector​

  1. In the sidebar, select Directory, then the Secrets tab.
  2. Select Add secret, then the Custom category.
  3. Select Add custom on Custom connector for a REST API, or on Custom MCP server for an MCP server.
  4. Enter a Name and, if you like, a Description. Both show in the connector list.
  5. Enter the Base URL (a REST API, for example https://api.example.com) or the Server URL (an MCP server, for example https://mcp.example.com/mcp).
  6. Pick the Auth: how a connection signs in.
    • REST API: Bearer token, Header key, Basic or OAuth2.
    • MCP server: None, Bearer token or OAuth2.
  7. Fill in the fields that choice adds:
    • Header: with Header key, the header the key goes in, for example X-API-Key.
    • Prefix: on a REST API with Bearer token or Header key, the word sent before the key. It starts as Bearer for a bearer token. Leave it blank for none.
    • Authorize URL and Token URL: on a REST API with OAuth2, the service's sign-in addresses.
    • Scope: with OAuth2, what sign-in asks for, separated by spaces.
    • Test path: on a REST API, where Test sends a GET, for example /v1/me.
    • Transport: on an MCP server, Streamable HTTP or SSE.
  8. Select Create. The connector opens on its Connections tab.

Connect to it​

  1. On the connector's Connections tab, go to Connect below the list. Others find the connector as its own card in the Custom category; selecting Connect there (Add another once connected) opens this tab.
  2. Enter a Name. Tasks find the secret by this name.
  3. Pick the Owner, Personal or Organization, if the form shows it.
  4. Fill in what the connector's Auth asks for: an API key, a Login and Password, a Token, or a Client ID and Client secret.
  5. Select Connect.
  6. With OAuth2, select Connect it in the message to finish signing in on the secret's page.

To change a definition later, open the connector and edit its Definition tab, then select Save. To delete it, select ⋯ beside its name, then Delete. That is refused while connections use it.

Every field is described in the Secrets reference. To store a catalog service instead, see Add a secret. To give a project's agents an MCP server you connected, see Give a project's agents an MCP server.