Developer MCP

Explore the Unipile API and test integrations with an AI client.

Developer MCP is intended for API documentation and integration testing during development. For end-user access, see User MCP.

Dashboard setup guide

On Overview, click Connect my project, then select Developer MCP and your client.

  • Leave Test with connected accounts off to use the API documentation without an API key.
  • Enable Test with connected accounts and create a development API key to test account actions. This global Account API Key can access every account in the Application, expires after 90 days, and is intended for development only. Save it securely before closing the guide; it cannot be shown again.

Copy the command or configuration into your client, restart it or reopen the session, and start a new conversation. The guide also offers an example prompt and a control to copy setup instructions for your coding assistant.

Installation

1. Choose documentation only or account actions

The MCP can be used simply to help your agent understand the Unipile API design and explore available endpoints.

For documentation only, omit the X-API-KEY header from the configurations below. You can also configure a scoped Account API Key to allow the agent to call account Methods on your behalf.

Before enabling account actions, create a dedicated Scope, assign only the accounts the client should access, and create a scoped Account API Key for that Scope.

Use this scoped key in the examples below. It limits the client to the accounts assigned to its Scope.

A Service Key or global Account API Key provides access to every account in the Application. The Dashboard-generated global key is for development only; for narrower access, use a scoped Account API Key as described above. Keep keys secret and only configure them in clients and environments you trust.


2. Set up your client

Choose your MCP client, then follow the instructions.

Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "unipile": {
      "url": "https://developer.unipile.com/mcp?branch=v2.0",
      "headers": {
        "X-API-KEY": "your-scoped-api-key"
      }
    }
  }
}

Next step

Once configured, you can test your MCP server connection:

  1. Open your AI client (Cursor, Windsurf, Claude, Codex, or ChatGPT desktop)
  2. Start a new chat with the AI assistant
  3. Ask about Unipile or request an account action. For example:
    • "How do I [common use case]?"
    • "Show me an example of [API functionality]"
    • "Create an [integration type] using Unipile"
    • "Send a message to [xxxx] using account acc_1234521321"
    • "List all emails in the [email protected] inbox"

The AI can consult the Unipile API Reference. When configured with a scoped key, it can also access the account data allowed by that Scope through the MCP server.


Available tools

  • list-specs - Lists all API specs available in the project, with their titles
  • list-endpoints - Returns all API paths and HTTP methods with their summaries
  • get-endpoint - Returns full detail on a specific endpoint: description, parameters, security
  • get-request-body - Returns the request body schema for an endpoint
  • get-response-schema - Returns the response schema for a specific endpoint and status code
  • list-security-schemes - Lists all authentication methods defined in your API spec
  • search-specs - Case-insensitive search across all paths, operations, and schemas
  • execute-request - Makes a live API call and returns the response. Requires auth headers to be forwarded
  • get-code-snippet - Generates a working code snippet for any endpoint in any programming language

Did this page help you?