Skip to main content
Glama

update_playbook

Update an existing playbook by merging the provided fields with the current config. Use when changing steps, name, description, or inputSchema of an automation such as a weekly report or ticket triage flow. The result may include studioUrl.

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": {
      "id": "<id>"
    },
    "name": "update_playbook"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
nameNo
stepsNo
descriptionNo
inputSchemaNo

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already signal a non-read-only, non-destructive mutation, so the bar is lower, and the description adds real value by disclosing merge behavior (unspecified fields preserved) plus a hint about the return payload (studioUrl). It omits permission/auth requirements, whether publishing is needed for changes to take effect, and how array fields like steps merge.

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 tight sentences, front-loaded with the update-and-merge contract before the usage context. The trailing "result may include studioUrl" is slightly hedged but still informative; nothing is redundant.

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 mutation tool with nested objects, no output schema, and 0% parameter documentation, the definition covers purpose and merge semantics but leaves structural gaps (steps format, id role, merge behavior for arrays, effect of updates on published state). Adequate but with clear omissions.

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 0%, so the description carries the burden, and it does enumerate four of the five fields (steps, name, description, inputSchema). However, it never explains the required id, the expected shape of steps or inputSchema, or whether array fields replace or append — leaving semantics thin for a 5-param tool with nested objects.

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?

Description opens with a specific verb+resource ("Update an existing playbook") and adds the crucial merge semantic, which distinguishes it from create_playbook or delete_playbook by implication. It does not explicitly name a sibling alternative, so it falls short of a 5.

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?

Explicitly states when to use it ("Use when changing steps, name, description, or inputSchema of an automation") and grounds it with concrete examples like a weekly report or ticket triage flow. It offers no when-not guidance or named alternative, but the merge framing makes the partial-update use case clear.

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