Skip to main content
Glama

Get playbook

get_playbook
Read-onlyIdempotent

Read ONE Playbook by id or title — operator contract (outcome, who, what Yes authorizes), steps, plan Agree seal, assignee, how-to (description = custom_instructions). Returns operator_brief (spoken summary, stage, what the human owes next) and deep_link into FO Plays. Always speak those; never cite this Play by id alone. Use before agree_playbook / run_playbook. list_playbooks is the index (same description key).

Routing: Inspect one Playbook (steps + whether the plan is Agreed) → use this. Speak operator_brief + deep_link; never id-alone.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
companyIdYesFreedomOS company id to act within (you must be a member). Required for company-scoped tools.
playbook_idNoUUID of the Playbook (use this or playbook_title).
playbook_titleNoTitle (or fragment) of the Playbook (use this or playbook_id).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / playbook_id
      Added value: +{
      +  "description": "UUID of the Playbook (use this or playbook_title).",
      +  "type": "string"
      +}
    • addedInput schema / properties / playbook_title
      Added value: +{
      +  "description": "Title (or fragment) of the Playbook (use this or playbook_id).",
      +  "type": "string"
      +}
    • removedInput schema / properties / tactic_id
      Removed value: -{
      -  "description": "UUID of the Playbook (use this or tactic_title).",
      -  "type": "string"
      -}
    • removedInput schema / properties / tactic_title
      Removed value: -{
      -  "description": "Title (or fragment) of the Playbook (use this or tactic_id).",
      -  "type": "string"
      -}
  2. Added

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already mark this read-only, idempotent, and non-destructive. The description adds meaningful behavioral expectations beyond that: it returns operator_brief and deep_link, and instructs the agent to 'Always speak those; never cite this Play by id alone.' This is valuable output-handling context not present in annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose and is organized into a useful routing note. However, it repeats the same instruction twice: 'never cite this Play by id alone' and 'Speak operator_brief + deep_link' appear in both the opening paragraph and the routing paragraph. This redundancy makes it less concise than it could be.

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?

There is no output schema, so the description reasonably compensates by naming the return fields (operator_brief, deep_link) and the expected presentation behavior. It also clarifies what a Playbook contains and where this fits in the workflow. Some domain-specific terms are dense, but an agent operating in this system likely has enough context to invoke it correctly.

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 100%, so the baseline is 3. The description mentions lookup 'by id or title', but the schema already documents playbook_id as a UUID and playbook_title as a title or fragment. The description does not add meaningful parameter-level detail beyond what the schema provides.

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?

The description opens with 'Read ONE Playbook by id or title', a specific verb, resource, and selection mechanism. It also differentiates from list_playbooks by calling it 'the index' and positions itself relative to agree_playbook and run_playbook.

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?

The description gives explicit routing: 'Use before agree_playbook / run_playbook' and states that list_playbooks is the index. The 'Routing' sentence provides a clear decision rule: inspect one Playbook's steps and Agree status, then use this tool.

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