Skip to main content
Glama

Change a workflow step

edit_step
Idempotent

Change one step: its name, settings (only the fields passed change; for an app step, integration_arguments are merged and null removes one), its messages (prompt steps; they replace the old ones) or its app action. Read it with get_step first. Start inputs are changed with update_workflow. The change is saved as a version: the answer's undo.version_id restores the steps from before it.

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": {
      "workflow_id": "<workflow_id>",
      "step_id": "<step_id>"
    },
    "name": "edit_step"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
step_idYesThe step id, e.g. "step_2".
messagesNo
settingsNoField names and new values (get_step_type).
app_actionNoA different action of the same app (search_actions).
workflow_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Adds substantial behavior beyond the annotations: settings are a patch (only passed fields change), integration_arguments merge with null deleting a key, messages fully replace prior ones, and the edit is versioned so undo.version_id can revert. This merge/replace distinction is the kind of context annotations cannot convey, and it is consistent with the declared idempotent/non-destructive hints since the change is reversible. Only the return shape beyond undo.version_id is left implicit, keeping it just short of 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.

Conciseness4/5

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

Front-loaded with the core action, then prerequisites, alternatives, and undo behavior in a logical order. The dense parentheticals in the first sentence cost some readability, but each clause carries distinct information and nothing is filler.

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 a six-parameter mutation with a nested settings object and no output schema, the description covers the risky parts: merge versus replace, null deletion, and how to revert via undo.version_id. It does not describe the success/error payload otherwise, but that is a minor gap given the tool's scope.

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

Parameters4/5

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

Schema coverage is 50%, and the description compensates well for the weak spots: it explains the patch semantics of settings and the replace semantics of messages, neither of which the schema states. app_action is clarified as "a different action of the same app," though workflow_id and step_id are covered only by schema/context rather than the description.

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 ("Change") and a scoped resource ("one step"), then enumerates the four editable facets: name, settings, messages, app action. It also distinguishes itself from get_step (read first) and update_workflow (start inputs), so an agent can route correctly without opening a schema.

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

Usage Guidelines5/5

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

Gives an explicit prerequisite ("Read it with get_step first") and an explicit alternative for a related but different target ("Start inputs are changed with update_workflow"). That covers when to use this tool versus the two most confusable siblings, leaving little to inference.

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