Workflow MCP Server v2

Workflow MCP exposes eligible published Flowgear Workflows as tools to an MCP client at the following endpoint.

https://<environment-hostname>/mcp

The hostname selects the Site Environment. Open the URL in a browser before registration and confirm the Flowgear endpoint response described in MCP Server.

Tool Workflow contract

A Workflow MCP tool has one MCP receive Step and one MCP respond Step.

The receive Step publishes a unique ToolName and a typed Arguments object. The respond Step maps StructuredContent and IsError. Flowgear wraps non-object content as { result: ... } and converts null to {}, but an explicit object response is the clearest contract.

Nested-only, missing, or duplicate respond Steps are invalid. Use containers for domain logic, then map the final result to the root respond Step.

Create a tool Workflow

  1. Create a Workflow.
  2. Add the MCP Node with the McpReceive Method and enter a unique ToolName.
  3. Add the MCP Node with the McpRespond Method.
  4. Add the Steps that perform the operation between the receive and respond Steps.
  5. Open Edit Properties on both MCP Steps and define the typed inputs and outputs.
  6. Save and Debug the Workflow.

Example

Paste this summarize-request example into Workflow Code view. It accepts typed values and returns them with a confirmation message.

Parameters: {}
Steps:
  - Name: "receiveTool"
    Description: "Receives a request for the summary."
    Node: "v2.Mcp@1.0.0.0"
    Method: "McpReceive"
    Parameters:
      ToolName:
        Type: "string"
        Sample: "summarize-request"
        Value: "summarize-request"
    Returns:
      Arguments:
        Type: "object"
        Properties:
          requestId:
            Type: "string"
            Sample: "REQ-001"
            Value: "REQ-001"
          quantity:
            Type: "number"
            Sample: 123
            Value: 123
          approved:
            Type: "boolean"
            Sample: true
            Value: true
          metadata:
            Type: "object"
            Properties:
              region:
                Type: "string"
                Sample: "ZA"
                Value: "ZA"
              priority:
                Type: "number"
                Sample: 2
                Value: 2
  - Name: "respondTool"
    Description: "Returns the request summary."
    Node: "v2.Mcp@1.0.0.0"
    Method: "McpRespond"
    Parameters:
      StructuredContent:
        Type: "object"
        Properties:
          requestId:
            Type: "string"
            Expression: "{receiveTool.Arguments.requestId}"
          quantity:
            Type: "number"
            Expression: "{receiveTool.Arguments.quantity}"
          approved:
            Type: "boolean"
            Expression: "{receiveTool.Arguments.approved}"
          metadata:
            Type: "object"
            Expression: "{receiveTool.Arguments.metadata}"
            Properties:
              region:
                Type: "string"
                Expression: "{receiveTool.Arguments.metadata.region}"
              priority:
                Type: "number"
                Expression: "{receiveTool.Arguments.metadata.priority}"
          message:
            Type: "string"
            Value: "Request received."
      IsError:
        Type: "boolean"
        Value: false
Returns: {}

Publish and discovery

In order for an MCP tool to be available to an MCP client (like an AI agent), the following conditions must be met:

  • The Workflow MCP feature is available.
  • The revision is published to the hostname's Environment.
  • The Workflow is enabled in that Environment.
  • Its tool name is valid and not in conflict.
  • The Delegate MCP user API Key targets that Environment and assigns the Workflow.
  • The signed-in user is permitted by the key and has effective access.

Publish, status, API-key assignment, and user access are separate. A failure in one does not change the others.

To publish and authorize a new tool:

  1. Publish the saved revision to the required Environment when Release Management is enabled.
  2. Return to the Workflow landing screen, open Workflow Status, and enable the Workflow for that Environment.
  3. Under API Keys, create a Delegate MCP user key for the same Environment.
  4. Select its permitted users and assign the Workflow, then save the key.
  5. Register the Environment's Workflow MCP endpoint in the client and complete user sign-in.

Build and operate tools

Use Create an MCP Tool Workflow for the focused receive, domain, respond, test, publish, and authorization journey.

Use Utility MCP Tools for narrow business actions or Exploratory MCP Tools for bounded read-only discovery. Keep mutation scope explicit, schemas small, errors deterministic, and Connections protected.

Utility Workflows perform a focused action such as approving a purchase order, listing service tickets, or updating a record. Exploratory tools let an agent progressively discover bounded data; a typical set lists available entities, describes an entity's fields, and runs a constrained query.

The MCP Screen supplies the Environment URL, prerequisites, client setup, eligible Workflow list, and status controls.