Skip to content

Build a custom connector

Create or adapt a connector for an app that is not in the catalog, including your own internal APIs. Your organization can then connect accounts to it and expose its methods as tools.

A custom connector is a connector that your organization owns. It is private to its owner until the owner shares it. It works wherever a catalog connector works, and restrictions still apply to it.

Where to find it: Connectors → New connector.

Before you start

You need Why
connector:create Build or fork a connector. The built-in Org Admin and Org Owner roles include it. People Admin, Team Admin, Member and Guest do not.
A plan that includes custom connectors Gold includes them. On other plans, New connector is disabled and its tooltip says "Custom connectors are not in your plan".

Choose how to start

Path When to use it How
Build from config The app has an API and no catalog connector matches. You describe its address, sign-in and methods. Connectors → New connector → Build from config
Add remote MCP server The app already runs an MCP server. Elaichi finds its tools when someone connects. Connectors → New connector → Add remote MCP server
Fork A catalog or custom connector is close but needs changes. Fork on the connector. See Share, fork and pull.

You cannot edit a catalog connector in place. Fork it first.

Build a connector from config

  1. Choose Connectors → New connector → Build from config.
  2. Enter the Name.
  3. Optional: enter a Category, such as crm.
  4. Check the Slug. Elaichi fills it in from the name until you edit it. Use lowercase letters, numbers and hyphens. The slug must be unique in your organization, and you cannot change it later.
  5. In Connector config, write the connector definition as JSON. It describes base_url, authorization, credentials and resources.
  6. Choose Create connector.

Elaichi opens the new connector's page. Choose Edit to describe its methods, as the next section explains. Until you describe a method, the connector exposes no tools.

Describe methods as tools

On the Edit page, the method documentation editor turns each API method into a tool.

  1. Choose Connectors, open your connector, and choose Edit.
  2. Under the method list, find the method. Use Search methods… to filter.
  3. Write a Description that says what the method does and when an AI client should use it.
  4. Optional: add a Query schema or a Body schema, as JSON Schema, when the method needs them.
  5. Optional: edit the Catalog description, which appears in the connector list and on the connector's page.
  6. Choose Save changes.

A method with a non-empty description is a tool, and the editor marks it MCP tool. A method with an empty description is marked Not an MCP tool, and AI clients do not see it. AI clients choose tools by reading their names and descriptions, so make each description specific to the job.

Existing connections keep working after you save. Newly described methods become tools for toolboxes and for AI clients.

Fix configuration errors

Elaichi checks the connector config when you save.

  • Invalid JSON, or JSON that is not an object, is flagged in the editor before you can save.
  • Server checks list Fix these connector config errors:. Each line shows the path of the problem, then a message. A line that starts with (root) applies to the whole config.

Fix every listed path, then save again.

Add a remote MCP server

  1. Choose Connectors → New connector → Add remote MCP server.
  2. Enter the Server URL.
  3. Enter the Name and the Slug. You cannot change the slug later.
  4. Fill in the details Elaichi asks for, then choose how members sign in under How members sign in.
  5. Create the connector.

A remote MCP connector's address and sign-in cannot be copied, so it has no Fork button. Its settings are on the Server tab of its page, not in the connector builder.

Delete a custom connector

  1. Open the connector's page.
  2. Choose the delete icon, then confirm with Delete.
Warning

Deleting a custom connector is permanent. Elaichi refuses it while any connection still uses the connector. Delete or replace those connections first.

Only the connector's owner sees the delete icon.

What to know

  • Sharing a custom connector gives people access to its definition. It does not share any connected accounts. Everyone connects with their own credentials.
  • A connector is private to its owner until the owner shares it. See Share, fork and pull.
  • After you build a connector, connect accounts the same way as for a catalog connector. See Connect an account.