MCP

Create a new MCP server

Changed on

Creates a new Model Control Protocol (MCP) server instance for the authenticated project. An MCP server provides a connection point for AI assistants to access your applications and services. The server is configured with specific authentication and tool permissions that determine what actions the connected assistants can perform.

post/api/v3.1/mcp/servers

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/mcp/servers
  • Auth
    API key in header x-api-key

Request body

namestring required

Human-readable name to identify this MCP server instance (4-30 characters, alphanumeric, spaces, and hyphens only)

auth_config_idsstring[] required

ID references to existing authentication configurations

no_auth_appsstring[]

List of NO_AUTH apps to enable for this MCP server

allowed_toolsstring[]

List of tool slugs that should be allowed for this server. If not provided, all available tools for the authentication configuration will be enabled.

managed_auth_via_composioboolean

Whether the MCP server is managed by Composio

Example request

{
  "name": "Production GitHub Integration",
  "auth_config_ids": [
    "ac_1a2b3c4d5e6f",
    "ac_7g8h9i0j1k2l"
  ],
  "no_auth_apps": [
    "exa",
    "codeinterpreter",
    "composio",
    "composio_search"
  ],
  "allowed_tools": [
    "GITHUB_CREATE_AN_ISSUE",
    "GITHUB_GET_A_REPOSITORY",
    "GITHUB_LIST_PULL_REQUESTS"
  ]
}

Response

MCP server created successfully. Returns the complete server configuration including connection details and command instructions.

idstring required

UUID of the MCP server instance

namestring required

User-defined descriptive name for this MCP server

auth_config_idsstring[] required

ID references to the auth configurations used by this server

allowed_toolsstring[] required

Array of tool slugs that this MCP server is allowed to use

mcp_urlstring required

[DEPRECATED] Please use the URL with user_id or connected_account_id query param

toolkitsstring[] required

Array of toolkit slugs that this MCP server is allowed to use

toolkit_iconsobject required

Object mapping each toolkit slug to its icon/logo URL for display purposes

updated_atstring required

Date and time when this server configuration was last modified

created_atstring required

Date and time when this server was initially created

server_instance_countnumber required

Total count of active user instances connected to this server

managed_auth_via_composioboolean required

Whether the MCP server is managed by Composio

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "GitHub Integration Server",
  "auth_config_ids": [
    "ac_1a2b3c4d5e6f",
    "ac_7g8h9i0j1k2l"
  ],
  "allowed_tools": [
    "GITHUB_CREATE_AN_ISSUE",
    "GITHUB_GET_A_REPOSITORY",
    "GITHUB_LIST_PULL_REQUESTS"
  ],
  "mcp_url": "https://backend.composio.dev/v3/mcp/550e8400-e29b-41d4-a716-446655440000?user_id=john",
  "toolkits": [
    "github",
    "jira",
    "slack"
  ],
  "toolkit_icons": {
    "github": "https://assets.composio.dev/logos/github.png",
    "jira": "https://assets.composio.dev/logos/jira.png",
    "slack": "https://assets.composio.dev/logos/slack.png"
  },
  "commands": {
    "cursor": "npx @composio/mcp@latest setup \"https://backend.composio.dev/v3/mcp/550e8400-e29b-41d4-a716-446655440000?user_id=john\" --client cursor",
    "claude": "npx @composio/mcp@latest setup \"https://backend.composio.dev/v3/mcp/550e8400-e29b-41d4-a716-446655440000?user_id=john\" --client claude",
    "windsurf": "npx @composio/mcp@latest setup \"https://backend.composio.dev/v3/mcp/550e8400-e29b-41d4-a716-446655440000?user_id=john\" --client windsurf"
  },
  "updated_at": "2023-06-15T14:30:00.000Z",
  "created_at": "2023-06-10T09:15:00.000Z",
  "server_instance_count": 5,
  "managed_auth_via_composio": true
}

Changes