Skip to main content
Glama

Create a workflow

create_workflow
Destructive

Save or programmatically provision new workflows owned by the authenticated user. Ensures unique names within your namespace.

Instructions

Create a new workflow owned by the authenticated user.

Authentication: Required.

Common Use Cases:

  • Save a newly built workflow

  • Programmatically provision workflows

Note: Workflow names must be unique within your namespace. Creating a workflow with a name you already use returns a 400 validation error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoUnique workflow name/slug within the user's namespace
titleNoHuman-readable workflow title
accountNoExact private account key profile label, not an authenticated provider owner ID.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete native JSON body, mutually exclusive with flat body flags and payload_file. Use schema for union bodies.
contentsNo
is_publicNoWhether the workflow is publicly visible
payload_fileNoAbsolute regular non-symlink private JSON file, at most 1 MiB. Cannot mix with other body inputs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "contents": {
      +    "description": "The workflow definition/configuration object",
      +    "properties": {
      +      "metadata": {
      +        "additionalProperties": {},
      +        "description": "Optional workflow metadata",
      +        "type": "object"
      +      },
      +      "name": {
      +        "description": "Internal name of the workflow definition",
      +        "type": "string"
      +      },
      +      "nodes": {
      +        "additionalProperties": {
      +          "additionalProperties": {},
      +          "type": "object"
      +        },
      +        "description": "Workflow nodes keyed by node id",
      +        "type": "object"
      +      },
      +      "output": {
      +        "additionalProperties": {
      +          "type": "string"
      +        },
      +        "description": "Output field mappings keyed by output name",
      +        "type": "object"
      +      },
      +      "schema": {
      +        "description": "Input/output schema for the workflow",
      +        "properties": {
      +          "input": {
      +            "additionalProperties": {},
      +            "description": "Input fields schema",
      +            "type": "object"
      +          },
      +          "output": {
      +            "additionalProperties": {},
      +            "description": "Output fields schema",
      +            "type": "object"
      +          }
      +        },
      +        "required": [
      +          "input",
      +          "output"
      +        ],
      +        "type": "object"
      +      },
      +      "version": {
      +        "description": "Workflow definition format version",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "name",
      +      "version",
      +      "nodes",
      +      "output",
      +      "schema"
      +    ],
      +    "type": "object"
      +  }
      +}
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for the requested mutation, paid work or private output file."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / contents / $ref
      Added value: +"#/$defs/contents"
    • removedInput schema / properties / contents / description
      Removed value: -"The workflow definition/configuration object"
    • removedInput schema / properties / contents / properties
      Removed value: -{
      -  "metadata": {
      -    "additionalProperties": {},
      -    "description": "Optional workflow metadata",
      -    "type": "object"
      -  },
      -  "name": {
      -    "description": "Internal name of the workflow definition",
      -    "type": "string"
      -  },
      -  "nodes": {
      -    "additionalProperties": {
      -      "additionalProperties": {},
      -      "type": "object"
      -    },
      -    "description": "Workflow nodes keyed by node id",
      -    "type": "object"
      -  },
      -  "output": {
      -    "additionalProperties": {
      -      "type": "string"
      -    },
      -    "description": "Output field mappings keyed by output name",
      -    "type": "object"
      -  },
      -  "schema": {
      -    "description": "Input/output schema for the workflow",
      -    "properties": {
      -      "input": {
      -        "additionalProperties": {},
      -        "description": "Input fields schema",
      -        "type": "object"
      -      },
      -      "output": {
      -        "additionalProperties": {},
      -        "description": "Output fields schema",
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "input",
      -      "output"
      -    ],
      -    "type": "object"
      -  },
      -  "version": {
      -    "description": "Workflow definition format version",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / contents / required
      Removed value: -[
      -  "name",
      -  "version",
      -  "nodes",
      -  "output",
      -  "schema"
      -]
    • removedInput schema / properties / contents / type
      Removed value: -"object"
    • addedInput schema / properties / payload / properties / contents / $ref
      Added value: +"#/$defs/contents"
    • removedInput schema / properties / payload / properties / contents / description
      Removed value: -"The workflow definition/configuration object"
    • removedInput schema / properties / payload / properties / contents / properties
      Removed value: -{
      -  "metadata": {
      -    "additionalProperties": {},
      -    "description": "Optional workflow metadata",
      -    "type": "object"
      -  },
      -  "name": {
      -    "description": "Internal name of the workflow definition",
      -    "type": "string"
      -  },
      -  "nodes": {
      -    "additionalProperties": {
      -      "additionalProperties": {},
      -      "type": "object"
      -    },
      -    "description": "Workflow nodes keyed by node id",
      -    "type": "object"
      -  },
      -  "output": {
      -    "additionalProperties": {
      -      "type": "string"
      -    },
      -    "description": "Output field mappings keyed by output name",
      -    "type": "object"
      -  },
      -  "schema": {
      -    "description": "Input/output schema for the workflow",
      -    "properties": {
      -      "input": {
      -        "additionalProperties": {},
      -        "description": "Input fields schema",
      -        "type": "object"
      -      },
      -      "output": {
      -        "additionalProperties": {},
      -        "description": "Output fields schema",
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "input",
      -      "output"
      -    ],
      -    "type": "object"
      -  },
      -  "version": {
      -    "description": "Workflow definition format version",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / properties / contents / required
      Removed value: -[
      -  "name",
      -  "version",
      -  "nodes",
      -  "output",
      -  "schema"
      -]
    • removedInput schema / properties / payload / properties / contents / type
      Removed value: -"object"
  2. First observedv2.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, openWorldHint=true, and idempotentHint=false. The description adds useful context the annotations don't carry: authentication is required, the resource is namespaced, and duplicate names yield a 400 validation error. It does not, however, explain the destructive hint or the mutually-exclusive body options (payload vs flat flags vs payload_file), so it only partially deepens the behavioral picture.

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?

Front-loaded with the core action, then auth and use cases, with a useful uniqueness constraint at the end. The bolded section headers are efficient; only the 'Common Use Cases' list is mildly expendable.

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

Completeness4/5

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

For an 8-parameter nested create tool with no output schema, the description covers purpose, auth, ownership, use cases, and the key duplicate-name failure mode. The remaining complexity (body union, is_public, confirm semantics) is adequately handled by the schema, leaving no critical gap for correct invocation.

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 88%, so the schema already documents nearly all 8 parameters, including the mutually-exclusive payload/contents/payload_file body shapes. The description adds no parameter-level syntax or semantics beyond that, so the baseline 3 applies.

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

Purpose4/5

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

States a specific verb+resource ('Create a new workflow') and clarifies ownership ('owned by the authenticated user'). An agent can readily tell it apart from the list_workflows/get_workflow siblings, though no sibling is named explicitly.

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?

The 'Common Use Cases' section gives clear when-to-use context (save a newly built workflow, programmatically provision workflows). It stops short of naming alternatives or stating when not to use it.

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