Overview
The MCP API provides programmatic access to manage Model Context Protocol servers, their tools, and integrations within FlowX.AI. Use these endpoints to automate MCP server configuration, test connections, and manage tool availability.All API endpoints require proper authentication and authorization. Ensure you have the necessary permissions to access Integration Management APIs.
Base URL
{your-domain} with your FlowX.AI deployment domain.
Authentication
All API requests must include authentication headers. The specific authentication mechanism depends on your FlowX.AI deployment configuration. Example Request Headers:MCP System Management
Create MCP System
Create a new MCP server connection as a data source.Path Parameters
Request Body
The name of the MCP server resource.Validation:
- Must be unique within the project
- Only letters, numbers, and special characters
[],(),.,_,-are allowed
Request Example
Response
Client secrets are not returned in API responses for security reasons.
Test MCP Connection
Test the connection to an MCP server before or after creating it.Path Parameters
Request Body
Request Example
Response
Get MCP System Details
Retrieve detailed information about an MCP system, including its tools.Path Parameters
Response
Get All Systems
Retrieve information about all available systems, including MCP servers, filtered by type.Path Parameters
Query Parameters
Response
This endpoint returns all system types (REST, NOSQL_DB, MCP). Filter by the
type field to identify MCP servers.Tool Management
Enable/Disable MCP Tool
Enable or disable a specific tool from an MCP server.Path Parameters
Request Body
Request Example
Response
Workflow Node Configuration
Custom Agent Node Structure
When creating or updating a Custom Agent node in a workflow, use the following structure:The
mcpServers array in aiOptions references MCP systems by their resourceDefinitionId and appId, allowing the Custom Agent to access enabled tools from those servers.Error Codes
Common HTTP status codes returned by MCP APIs:Common Error Messages
Name Validation Errors
Name Validation Errors
Error: “Name must be unique inside the project.”Cause: An MCP system with this name already exists in the project.Solution: Choose a different, unique name.
Error: “Name can only contain letters, numbers and the following special characters [] () . _ -”Cause: The name contains invalid special characters.Solution: Remove or replace invalid characters with allowed ones.
Error: “Name can only contain letters, numbers and the following special characters [] () . _ -”Cause: The name contains invalid special characters.Solution: Remove or replace invalid characters with allowed ones.
Connection Errors
Connection Errors
Error: “Connection failed: Invalid authentication credentials”Cause: The provided authentication credentials are incorrect or expired.Solution: Verify the client ID, client secret, and identity provider URL.
Error: “Connection failed: MCP server is unreachable”Cause: The MCP server is down or the URL is incorrect.Solution: Verify the server URL and ensure the server is running.
Error: “Connection failed: MCP server is unreachable”Cause: The MCP server is down or the URL is incorrect.Solution: Verify the server URL and ensure the server is running.
Rate Limiting
Rate limiting policies depend on your FlowX.AI deployment configuration. Contact your system administrator for specific rate limit details.
Next steps
Add MCP Data Source
Learn how to configure MCP servers via UI
Custom Agent Node
Use MCP tools in Integration Designer workflows
Related resources
MCP Integration Overview
Learn about MCP integration capabilities
Integration Designer
Learn about Integration Designer and data sources

