Skip to main content
Glama

publish_playbook

Destructive

Publish a playbook: snapshot the working copy and promote it to the live version. Webhooks and run_playbook use the live version. Use after editing when the user wants the new definition to be what runs. Fails if another member holds the edit lock.

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": "publish_playbook"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesPlaybook ID

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.4/5.0
Behavior4/5

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

Goes well beyond the annotations by disclosing the snapshot/promote semantics, the fact that webhooks and run_playbook read the live version, and a concrete failure mode (fails if another member holds the edit lock). It stops short of stating what happens to the previously live version or whether publishing can be rolled back, which matters given destructiveHint=true.

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?

Four short sentences, front-loaded with the verb and mechanism, then consequences, then the trigger, then the failure mode. Nothing is redundant with the annotations or restated.

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 one-parameter mutation, the description covers purpose, trigger, consumers, and a locking failure mode, with annotations already carrying the destructive profile. It leaves minor gaps around post-publish state (whether the working copy changes) and rollback behavior, which are the only things an agent might still need.

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?

Single parameter with 100% schema description coverage; the schema already documents 'id' as the Playbook ID. The description does not add format details or clarify whether the ID refers to the working copy or the playbook entity, so it is baseline rather than additive.

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 and resource (publish a playbook) and then defines the mechanism precisely: snapshot the working copy and promote it to the live version. This distinguishes it from update_playbook (which edits the working copy) and run_playbook (which consumes the live version), so an agent can choose correctly without opening schemas.

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 trigger condition: 'Use after editing when the user wants the new definition to be what runs.' It also names the downstream consumers (webhooks and run_playbook) that make publication matter, so the agent knows why and when to escalate from editing to publishing.

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