Skip to main content
Glama

update_gym_workflow

Edit a gym-wide workflow (replaces the whole definition). (confirm-gated: previews until confirm: true)

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": {
      "organizationId": "<organizationId>",
      "id": "<id>",
      "input": "<input>"
    },
    "name": "update_gym_workflow"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
inputYes
confirmNoMust be true to actually execute. If false/omitted, returns a preview only.
organizationIdYesGym id (from list_my_organizations)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / input / properties / sequence
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Required when trigger.type is \"weekly_sequence\" (a weekly message series); actions then only carries the delivery channel",
      +  "properties": {
      +    "messages": {
      +      "description": "Message 1 goes out on the first weekday after a client starts, message 2 a week later, and so on",
      +      "items": {
      +        "maxLength": 1000,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "maxItems": 52,
      +      "minItems": 1,
      +      "type": "array"
      +    },
      +    "planIds": {
      +      "description": "Only clients on these plans; omit for every client",
      +      "items": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "weekday": {
      +      "description": "0=Sunday..6=Saturday, read in each client's own time zone",
      +      "maximum": 6,
      +      "minimum": 0,
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "weekday",
      +    "messages"
      +  ],
      +  "type": "object"
      +}
  2. Added

TDQS

A3.5/5.0
Behavior4/5

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

Annotations only say readOnlyHint=false; the description adds two traits beyond that: the operation is a full destructive replacement of the existing definition, and it is confirm-gated with a preview mode by default. That is exactly the kind of safety-relevant context annotations don't carry. It stops short of stating permission requirements or what the preview returns, so not 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 compact clauses with no filler; the replacement semantics and the confirm gate are both front-loaded where an agent will see them before the schema.

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?

Given a mutation tool with a large nested payload and no output schema, the description covers the replacement and preview behaviors but says nothing about required input composition (name/trigger/actions), the weekly_sequence conditional, or how to source the id. Adequate as a safety note, thin as a calling guide for a 4-parameter, nested-schema tool.

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

Parameters2/5

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

Schema description coverage is only 50% and the input contains a deeply nested object (input.trigger, input.actions, input.sequence) whose semantics the description never touches. The only parameter behavior mentioned, the confirm gate, is already fully documented in the schema's own description of confirm, so the description adds no meaning over structured data.

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 and resource ('Edit a gym-wide workflow') and adds the crucial scope note that it replaces the entire definition, which separates it from set_gym_workflow_enabled and update_workflow. It doesn't explicitly name those siblings, so an agent must infer the gym-vs-personal distinction, but the purpose itself is unambiguous.

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

Usage Guidelines3/5

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

The parenthetical makes clear that editing replaces the whole definition and that execution is gated behind confirm: true with preview-by-default, which implies when the tool will actually mutate state. However, it never states when to prefer this over update_workflow, set_gym_workflow_enabled, or delete_gym_workflow, leaving the alternative selection 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.