Skip to main content
Glama
DOC Model Safety Gate

DOC Model Safety Gate

by laceykes

createWorkflow

Create a step-based workflow definition with at least one step, or set up the definition before adding graph nodes and edges for human-reviewed content changes.

Instructions

Create a workflow definition (the step-based editor path). The API requires at least one step: pass steps as an array of { position, stepType, configJson, isEnabled? }. For graph-based workflows, create the definition here, then add nodes and edges with the graph tools.

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": {
      "projectId": "<projectId>",
      "siteId": "<siteId>",
      "name": "<name>",
      "targetCollectionId": "<targetCollectionId>",
      "steps": "<steps>"
    },
    "name": "createWorkflow"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesWorkflow name
stepsYesAt least one step: { position, stepType, configJson, isEnabled? }
siteIdYesSite ID
projectIdYesProject ID
descriptionNoOptional description
triggerTypeNoTrigger type (defaults to manual on the server)
targetCollectionIdYesTarget collection ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It usefully discloses a server-side validation constraint ("The API requires at least one step") and the element shape, but says nothing about permissions, whether the created workflow is a draft, or side effects of creation.

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?

Three compact sentences with the identifying purpose front-loaded, then the hard constraint, then the graph-workflow follow-up. No filler, though the inline object shape is dense for prose.

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

Completeness3/5

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

For a 5-required-parameter creation tool with no annotations and no output schema, the description covers the creation path and the graph follow-up, but omits what is returned (notably the new workflow's identifier) which an agent needs before calling createWorkflowNode/createWorkflowEdge.

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 description coverage is 100%, so the schema already documents all seven parameters; the description only restates the steps item shape and its minimum-length constraint. It adds no meaning for triggerType, targetCollectionId, or how name/project/site interact.

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 and resource ("Create a workflow definition") and immediately scopes it to the step-based editor path, which distinguishes it from the graph tools in the sibling list. An agent can tell which creation route to take without opening any schema.

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

Usage Guidelines4/5

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

Gives explicit routing guidance: use this for step-based workflows, and for graph-based workflows create the definition here first, then add nodes and edges with the graph tools. It stops short of naming the specific sibling tools (createWorkflowNode/createWorkflowEdge) or stating exclusions, but the sequencing instruction is clear.

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