Skip to main content
Glama

Create Workflow From Template

workflow.from_template

Create a workflow on a sheet from a built-in template (workflow.list templates). It is a draft and off; adjust it with workflow.update and turn it on with workflow.publish.

Input Schema

NameRequiredDescriptionDefault
nameNo
formIdNoA form id (sheet_schema peeks of kind form): a form of the sheet; the workflow runs only for that form's responses. Only for a template that starts on a new row
sheetIdYesThe sheet the workflow runs on
templateIdYesA template id from workflow.list templates

Output Schema

NameRequiredDescriptionDefault
nameYes
nodesYesEvery step after the trigger, in canvas order
sheetYes
stateYes
triggerYes
workflowIdYes
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / formId
      Added value: +{
      +  "description": "A form id (sheet_schema peeks of kind form): a form of the sheet; the workflow runs only for that form's responses. Only for a template that starts on a new row",
      +  "maxLength": 64,
      +  "pattern": "^[A-Za-z0-9_-]+$",
      +  "type": "string"
      +}
    • addedOutput schema / properties / nodes / items / properties / onError
      Added value: +{
      +  "description": "If the action fails (integration_action, agent, transcribe and run_workflow steps only): stop, continue (skip failed items) or fallback_path (error branch, its steps on port `error` in next)",
      +  "enum": [
      +    "stop",
      +    "continue",
      +    "fallback_path"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / properties / trigger / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "config": {
      -        "additionalProperties": {},
      -        "description": "Secrets (authorization, API keys, tokens) read as ••••••; send them back unchanged to keep them",
      -        "propertyNames": {
      -          "type": "string"
      -        },
      -        "type": "object"
      -      },
      -      "name": {
      -        "type": "string"
      -      },
      -      "next": {
      -        "items": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "port": {
      -              "type": "string"
      -            },
      -            "ref": {
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "port",
      -            "ref"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      "operation": {
      -        "type": "string"
      -      },
      -      "ref": {
      -        "description": "The node's id: name it in workflow.update as after, ref or {{steps.<ref>.<path>}}",
      -        "type": "string"
      -      },
      -      "type": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "ref",
      -      "name",
      -      "type",
      -      "config",
      -      "next"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "config": {
      +        "additionalProperties": {},
      +        "description": "Secrets (authorization, API keys, tokens) read as ••••••; send them back unchanged to keep them",
      +        "propertyNames": {
      +          "type": "string"
      +        },
      +        "type": "object"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "next": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "port": {
      +              "type": "string"
      +            },
      +            "ref": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "port",
      +            "ref"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "onError": {
      +        "description": "If the action fails (integration_action, agent, transcribe and run_workflow steps only): stop, continue (skip failed items) or fallback_path (error branch, its steps on port `error` in next)",
      +        "enum": [
      +          "stop",
      +          "continue",
      +          "fallback_path"
      +        ],
      +        "type": "string"
      +      },
      +      "operation": {
      +        "type": "string"
      +      },
      +      "ref": {
      +        "description": "The node's id: name it in workflow.update as after, ref or {{steps.<ref>.<path>}}",
      +        "type": "string"
      +      },
      +      "type": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "ref",
      +      "name",
      +      "type",
      +      "config",
      +      "next"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. Changed2 schema fields changed
    • addedOutput schema / properties / nodes / items / properties / config / description
      Added value: +"Secrets (authorization, API keys, tokens) read as ••••••; send them back unchanged to keep them"
    • changedOutput schema / properties / trigger / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "config": {
      -        "additionalProperties": {},
      -        "propertyNames": {
      -          "type": "string"
      -        },
      -        "type": "object"
      -      },
      -      "name": {
      -        "type": "string"
      -      },
      -      "next": {
      -        "items": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "port": {
      -              "type": "string"
      -            },
      -            "ref": {
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "port",
      -            "ref"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      "operation": {
      -        "type": "string"
      -      },
      -      "ref": {
      -        "description": "The node's id: name it in workflow.update as after, ref or {{steps.<ref>.<path>}}",
      -        "type": "string"
      -      },
      -      "type": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "ref",
      -      "name",
      -      "type",
      -      "config",
      -      "next"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "config": {
      +        "additionalProperties": {},
      +        "description": "Secrets (authorization, API keys, tokens) read as ••••••; send them back unchanged to keep them",
      +        "propertyNames": {
      +          "type": "string"
      +        },
      +        "type": "object"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "next": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "port": {
      +              "type": "string"
      +            },
      +            "ref": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "port",
      +            "ref"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "operation": {
      +        "type": "string"
      +      },
      +      "ref": {
      +        "description": "The node's id: name it in workflow.update as after, ref or {{steps.<ref>.<path>}}",
      +        "type": "string"
      +      },
      +      "type": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "ref",
      +      "name",
      +      "type",
      +      "config",
      +      "next"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  3. Added

TDQS

A4/5.0
Behavior4/5

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

The annotations already declare non-read-only, non-destructive, non-idempotent behavior. The description adds the crucial state fact that the created workflow is 'a draft and off' and therefore inert until published, which is real behavioral context not present in the annotations or schema. It does not cover permissions or failure modes, keeping it below a 5.

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

Conciseness5/5

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

Two tight sentences: the first states the action and template source, the second states the resulting state and the follow-up tools. The most important constraint (draft/off) is front-loaded and nothing is redundant.

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?

With an output schema present, return values need no explanation, and the description covers the action, the template source, the post-creation state and the activation path. The only gap is the unrelated optional 'name' parameter, which is neither described in the schema nor the description.

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 75%, with templateId, sheetId and formId all documented in the schema, including the conditional note that formId only applies to templates starting on a new row. The description adds only the hint that templateId comes from workflow.list templates and provides no meaning for the undocumented 'name' parameter. Baseline 3 is appropriate where the schema does the heavy lifting.

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?

The description gives a specific verb and resource ('Create a workflow on a sheet from a built-in template') and names the source of the template, which separates it from sibling tools like workflow.update, workflow.publish and workflow.list. It stops short of an explicit contrast with other creation paths, but the resource and origin are unambiguous.

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?

It explicitly routes the agent: fetch candidate templates via workflow.list, then after creation adjust via workflow.update and activate via workflow.publish. That is a clear before/after usage path. It does not state when this tool should be avoided, so it falls short of full when/when-not coverage.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources