Skip to main content
Glama

get_playbook

Read-only

Returns the OrgGen manual for a diagram kind: the rules an agent must follow so that its writes produce a correct AND visible result. It is read before a first series of writes on a kind not yet handled: the most costly mistakes here raise no exception (content written but never displayed, a block placed off-screen, wrong percentages in a cap table) — nothing signals the failure. Without arguments, returns the cross-kind rules. With 'topic', restricts to one topic.

Input Schema

NameRequiredDescriptionDefault
kindNoDiagram kind whose rules you want. Omitted, returns the cross-kind rules only. The kind present in the project is read with get_schema_overview: the playbook of another kind is of no use.
topicNoRestricts to one topic. Omitted, returns EVERYTHING that applies to the kind — it is voluminous but it is the recommended read before a first series of writes. Useful topics: 'placement' (coordinates, layout), 'contenu' (content: desc vs contentBlocks), 'ownership' (percentages), 'modelisation' (modeling: entities, relations), 'workflow' (order of operations).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / kind / description
      Previous value: -"Type de diagramme dont on veut les règles. Omis, rend les règles transverses uniquement. Le type présent dans le projet se lit avec get_schema_overview : le playbook d'un autre type ne sert pas."New value: +"Diagram kind whose rules you want. Omitted, returns the cross-kind rules only. The kind present in the project is read with get_schema_overview: the playbook of another kind is of no use."
    • changedInput schema / properties / topic / description
      Previous value: -"Restreint à un thème. Omis, rend TOUT ce qui s'applique au type — c'est volumineux mais c'est la lecture recommandée avant une première série d'écritures. Thèmes utiles : 'placement' (coordonnées, layout), 'contenu' (desc vs contentBlocks), 'ownership' (pourcentages), 'modelisation' (entités, relations), 'workflow' (ordre des opérations)."New value: +"Restricts to one topic. Omitted, returns EVERYTHING that applies to the kind — it is voluminous but it is the recommended read before a first series of writes. Useful topics: 'placement' (coordinates, layout), 'contenu' (content: desc vs contentBlocks), 'ownership' (percentages), 'modelisation' (modeling: entities, relations), 'workflow' (order of operations)."
  2. Changed1 schema field changed
    • changedInput schema / properties / kind / description
      Previous value: -"Type de diagramme dont on veut les règles. Omis, rend les règles transverses uniquement. Si tu ne sais pas, appelle get_schema_overview d'abord : le playbook du mauvais type ne t'aidera pas."New value: +"Type de diagramme dont on veut les règles. Omis, rend les règles transverses uniquement. Le type présent dans le projet se lit avec get_schema_overview : le playbook d'un autre type ne sert pas."
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

With readOnlyHint/openWorldHint already covering safety, the description still adds real behavioral context: the highest-cost errors are silent (content written but never displayed, blocks off-screen, wrong cap-table percentages) and nothing raises an exception. It also warns the topic-less read is voluminous, which sets output-size expectations.

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?

Purpose and usage lead, with the silent-failure rationale and argument behavior following in a logical order. The parenthetical examples in the middle sentence are a little dense, but each clause carries information rather than filler.

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?

With no output schema, the description must convey what comes back: it frames the return as prose rules organized by kind and topic and flags the volume of the unfiltered read. That is sufficient for an agent to decide to read it before writing, though the actual structure of the returned rules is left implicit.

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% and both parameters carry enums with their own explanations, so the schema does the heavy lifting. The description's 'Without arguments, returns the cross-kind rules / with topic restricts' largely restates the schema rather than adding new syntax or format meaning, so the baseline 3 is appropriate.

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 — returns the OrgGen 'manual' (rules) for a diagram kind — and scopes it further (cross-kind rules without arguments, single topic with 'topic'). It is clearly distinguishable from the write siblings and from get_schema_overview, which it explicitly names as a different lookup.

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?

'It is read before a first series of writes on a kind not yet handled' gives a concrete trigger condition, and the schema notes that a kind's playbook is useless without matching the project's kind read via get_schema_overview. It never states an explicit 'do not use' case or names a true alternative tool, so it stops short of a 5.

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.