4.4.1 Provide MCP Server Details

Enter MCP server details to register an external MCP integration in MicroTx Workflows and to use it as a tool during workflow execution.

Later, you can reference the configured MCP servers in agentic planner tasks, agent profiles used by agentic task in workflow execution, and agent profiles used by conversational agent APIs.

At runtime, MicroTx Workflows discovers the tools exposed by the configured MCP servers and makes available for workflow task and agent execution.

Before providing MCP server details, ensure the following points:

  • The MCP server endpoint or process command is available and MicroTx Workflows can access it.
  • Identify the transport mode and provide the command if you select STDIO as the transport mode or provide the URL if you select SSE.

    Note:

    Use STDIO transport only when the MCP server can be started as a local process from the MicroTx Workflows server at runtime. In Docker or Kubernetes deployments, the command is executed inside the workflow server container or pod, not on the client machine. Ensure that the executable, runtime dependencies, scripts, environment variables, permissions, and any required files are available in that container. For example, to use an npx-based MCP server, ensure that Node.js, npm, npx and the required MCP package must be installed or packaged in the workflow server image. If the MCP server runs in a separate container, pod, host, or managed service, use SSE or HTTP-based transport instead of STDIO.
  • MCP server connections support authentication using API token and token propagation. To authenticate using API key, ensure that a valid API token is available. To authenticate using token propagation, ensure that token propagation is enabled in your environment.
  • The MCP server exposes the tools you want to use during agent or planner execution.
  1. Open the navigation menu and click Connectors.
  2. Click MCP Server.

    The MCP Definitions list page opens. All the MCP servers that you have defined are displayed in a table.

  3. Click add a new building block.
    The New MCP Definition dialog box appears.
  4. Enter the following information.
    • Name: Enter a unique, descriptive name for your MCP server. The name must be between 1 to 128 characters long, must start with an alphabet, and can contain only letters, numbers, underscores (_), and hyphens (-). Spaces and other special characters are not supported. This name helps you identify this MCP server definition in tasks and workflows.

    • Description: Optional. Add details describing the purpose or scope of this MCP server definition.

    • Transport: Select one of the following network transport protocols which the MCP server uses to establish a connection.
      • STDIO: Select this option when MicroTx Workflows must launch a local MCP process or command and communicate over stdin (standard input) and stdout (standard output).
      • SSE: Select this option when MCP server is hosted remotely and can be accessed over HTTP or HTTPS with server-sent events.
    • Provide the following configuration information additionally only if you select SSE in the Transport drop-down list.
      • Authorization: Optional. Select one of the following options to set up authorization.
        • API Key to grant access to the MCP server with the provided API key. You will need to include the JWT token, which authorizes workflow execution, as the authorization bearer token with every request to the MCP server.
        • Token Propagation to allow MicroTx Workflows to automatically propagate the JWT token which is sent to the MCP server with every request. Select this option when caller token propagation is configured for your environment.
        • None Select this option for public or internal trusted MCP endpoints with no authorization requirement.

      • URL: Provide the base URL of the MCP server.

      • SSE Endpoint: Optional. Enter the full endpoint path for server-sent events (SSE). This is required for communicating with the MCP server. For example, /sse/notifications. The default value is /sse.
      • API Key: Enter the API key which MicroTx Workflows uses to grant access the MCP server. You must provide an API key if you have selected API Key as the option to set up authorization. This is a secret credential and should be treated as sensitive data.
    • Provide the following configuration information only if you select STDIO in the Transport drop-down list.

      • Command: Required. Enter the executable command used to start the MCP server process, such as binary or script.

      • Args (comma-separated): Optional. Enter a comma-separated list of command-line arguments passed to the command when starting the MCP server process.
  5. Click Test to ensure that you can establish a connection with the provided details.
    If there are any issues, an error message is displayed. Note down the error message so that you can troubleshoot the issue, and then click Close.
  6. Click Submit to create a new MCP definition with the details you have provided and save your configuration.

You can use the MCP server details within Agentic Planner task and in the Agent profiles, which are used in Agentic task inside workflow and the Conversational agent chat API.

Parent topic: Manage MCP Server Details