Management API
Create MCP Server Instance
Create a new MCP server instance.
POST
Overview
This endpoint creates a new MCP server connection, allowing users to connect to supported integrations like Pipedrive, HubSpot, Salesforce, and others.
Prerequisites
- Valid OAuth Token - Bearer token with
mgmt.write
scope - Integration Support - The integration must be available and supported
Request
Headers
Header | Type | Required | Description |
---|---|---|---|
Authorization | string | Yes | Bearer token from OAuth authentication |
Content-Type | string | Yes | Must be application/json |
Request Body
Request Fields
Field | Type | Required | Description |
---|---|---|---|
mcp_server | string | Yes | Integration name (e.g., “pipedrive”, “hubspot”) |
access_type | string | Yes | Access level: “read”, “write”, or “individual” |
api_key | string | Yes | API key for the integration |
Access Types
read
- Read-only access to integration datawrite
- Full read/write access to integration dataindividual
- Custom access with specific tool selections
Response
Success Response (201 Created)
Response Fields
Field | Type | Description |
---|---|---|
success | boolean | Whether the request was successful |
data.id | integer | Unique identifier for the connection |
data.mcp_server_name | string | Human-readable name of the integration |
data.api_key_verification_status | string | API key validation status (“pending”, “verified”, “failed”) |
data.oauth2_client_id | string | OAuth2 client ID for MCP server communication |
data.oauth2_scopes | array | OAuth2 scopes granted for this connection |
data.agent_enabled | boolean | Whether the connection is enabled for agent use |
data.disabled_tools | array | List of disabled tool IDs (empty for non-individual access) |
data.created_at | string | ISO timestamp when connection was created |
Error Responses
Bad Request (400)
Unauthorized (401)
Forbidden (403)
Internal Server Error (500)
Examples
Create Pipedrive Connection
Response
Create HubSpot Connection (Read-only)
Implementation Notes
Automatic Configuration
agent_enabled
is automatically set totrue
api_key_verification_status
starts as “pending” and is verified asynchronouslyoauth2_client_id
andoauth2_scopes
are automatically generateddisabled_tools
array is empty for “read” and “write” access types
OAuth Client Registration
- An OAuth2 client is automatically created for the connection
- OAuth credentials are generated and associated with the connection
- This enables secure tool execution with proper scoping
Validation
- Integration name is validated against available integrations
- Access type is validated against supported values
- API key format is validated before storage
Database Storage
- Connection is stored in the web database
- Database IDs are mapped from user-friendly names
- All fields are properly validated before creation
Related Endpoints
- Get Available Integrations - List available integrations
- Get Connection Details - Get connection information
- Update Connection - Modify connection settings
- Get Connection Tools - List available tools
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Response
201 - application/json
MCP server connection created successfully
The response is of type object
.