Skip to main content
Glama

get_playbook

Read-onlyIdempotent

Get a playbook by ID, including its steps and configuration. Use when inspecting how an automation works before editing or running it. The result may include studioUrl for opening the playbook in Studio.

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

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so safety is covered. The description adds value beyond that by disclosing the shape of the response (steps, configuration, and a possible studioUrl for opening in Studio), which tells an agent what it will actually get back. It says nothing about failure behavior for an invalid ID or whether the full step graph is always returned.

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 short sentences, front-loaded with the core behavior, then usage context, then return detail. Little waste, though the studioUrl sentence is a minor detail that could be trimmed if space were at a premium.

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 simple one-parameter read tool with no output schema, the description covers what it does, when to reach for it, and roughly what comes back. Nothing critical is missing for correct invocation; only edge-case behavior for invalid IDs is unaddressed.

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?

With a single parameter and 0% schema description coverage, the description carries the burden, and it only implicitly identifies id as the playbook identifier. It adds no format, source, or constraint information (e.g., where to obtain the ID) beyond what the name 'get_playbook' already implies.

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 ('Get a playbook by ID') and names the payload it returns ('its steps and configuration'), so it is clearly distinguished from siblings like get_run or get_agent. It stops short of any explicit differentiation from other playbook-scoped tools such as verify_playbook or update_playbook.

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?

'Use when inspecting how an automation works before editing or running it' gives a concrete motivating scenario that points at update_playbook and run_playbook as the downstream actions. It does not state when not to use it or name an alternative tool for a different retrieval need.

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