FrameIO MCP Server

generate_workflow

Generate workflow definitions with states, transitions, and approvals using a builder for FrameIO entities.

Instructions

Generate workflow definitions with states, transitions, and approvals using defineWorkflow() builder

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workflowKey": "<workflowKey>",
      "name": "<name>",
      "description": "<description>",
      "entityKey": "<entityKey>",
      "statusField": "<statusField>",
      "states": "<states>",
      "transitions": "<transitions>"
    },
    "name": "generate_workflow"
  }
}

Input Schema

Name	Required	Description
`name`	Yes	Workflow display name
`states`	Yes	Array of workflow states
`entityKey`	Yes	Entity key this workflow applies to (e.g., pos.order)
`description`	Yes	Workflow description
`statusField`	Yes	Field name that stores the workflow status (e.g., status)
`transitions`	Yes	Array of state transitions
`workflowKey`	Yes	Workflow key in format {module-id}.{workflow-name} (e.g., pos.order-approval)

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Sep 4, 2026

TDQS

B3.1/5.0

Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It only says 'Generate workflow definitions' and mentions the builder, but doesn't disclose side effects (e.g., file creation, modification, validation) or error behavior. This is a significant gap for a generation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One concise sentence with no redundancy, and the action is front-loaded. However, it is minimal to the point of omitting essential context, so it doesn't earn a top score.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 7 required parameters, nested objects, and no output schema, the description should clarify what the tool returns, any validation rules, or examples. It only mentions the builder, leaving agents without enough context to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so all 7 parameters are described in the schema. The description adds no extra meaning beyond the schema, which is adequate per the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Generate') and resource ('workflow definitions'), and names the builder method. Clearly distinct from sibling tools like generate_module or generate_entity, which target different artifacts.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus the many other generate_* siblings, nor any prerequisites or conditions. The description only states what it does, not when to select it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.