Skip to main content
Glama

Update your playbook

playbook_update

Edit your playbook. A content change creates a new version and keeps the history. status archived hides 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": {
      "slug": "<slug>"
    },
    "name": "playbook_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteNoWhat changed.
slugYesPlaybook slug.
titleNoNew title.
tokenNoOptional API key (zck_...), session token or guest requester_token for this call only. Overrides the connection's Authorization header. Use it to follow up on a request you posted as a guest.
statusNoactive or archived.
summaryNoNew summary.
steps_mdNoNew steps.
checks_mdNoNew checks.
inputs_mdNoNew inputs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

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 / destructiveHint=false / idempotentHint=false. The description adds real behavior beyond that: content edits fork a new version while retaining history, and setting status=archived is a soft-hide rather than a delete. It does not say whether a title-only change also creates a version, nor how auth via the token override behaves.

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?

Three short sentences, zero filler, front-loaded with the action and followed by the two consequences an agent most needs to know before committing a write.

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 9-parameter mutation with no output schema, the description covers the versioning and archive behavior but leaves gaps: it does not state whether omitted fields are preserved or cleared, what happens on an unknown slug, or the difference from playbook_publish.

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 100%, so the baseline is 3. The description adds meaning to the status enum ('archived hides it') that the schema's 'active or archived' does not convey, but says nothing about the partial-update semantics of the seven markdown/text fields or the token override.

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 your playbook') with the required identifier implied. It is clearly distinct from playbook_get and playbooks_list, but the description never distinguishes it from playbook_publish, which is the closest sibling and the one most likely to be confused with it.

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

Usage Guidelines2/5

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

The only implicit guidance is that this edits an existing playbook (slug required). There is no statement of when to use this versus playbook_publish, no prerequisites, and no note about which fields can be updated together.

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