Skip to main content
Glama

academy_playbook

Read-onlyIdempotent

Read an existing public playbook.

Input Schema

NameRequiredDescriptionDefault
idYes
localeNoMCP transport locale; not a service input field.de
idempotencyKeyNoTransport retry key, forwarded as Idempotency-Key.

Output Schema

NameRequiredDescriptionDefault
errorsYes
resultYes
successYes
messagesYes
request_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedInput schema / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / id
      Added value: +{
      +  "maxLength": 240,
      +  "minLength": 1,
      +  "pattern": "^[a-zA-Z0-9][a-zA-Z0-9:_.-]*$",
      +  "type": "string"
      +}
    • addedInput schema / properties / idempotencyKey
      Added value: +{
      +  "description": "Transport retry key, forwarded as Idempotency-Key.",
      +  "maxLength": 200,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / locale / default
      Added value: +"de"
    • changedInput schema / properties / locale / description
      Previous value: -"Language. de=German, en=English, es=Spanish. Default en."New value: +"MCP transport locale; not a service input field."
    • removedInput schema / properties / slug
      Removed value: -{
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "slug"
      -]New value: +[
      +  "id"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "oneOf": [
      +    {
      +      "properties": {
      +        "errors": {
      +          "maxItems": 0
      +        },
      +        "result": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "content": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "body": {
      +                  "type": "string"
      +                },
      +                "bodyLocale": {
      +                  "type": "string"
      +                },
      +                "bodyPending": {
      +                  "type": "boolean"
      +                },
      +                "category": {
      +                  "type": "string"
      +                },
      +                "description": {
      +                  "type": "string"
      +                },
      +                "duration": {
      +                  "type": "string"
      +                },
      +                "locale": {
      +                  "enum": [
      +                    "de",
      +                    "en",
      +                    "es"
      +                  ],
      +                  "type": "string"
      +                },
      +                "order": {
      +                  "type": "number"
      +                },
      +                "published": {
      +                  "type": "string"
      +                },
      +                "slug": {
      +                  "type": "string"
      +                },
      +                "title": {
      +                  "type": "string"
      +                },
      +                "updated": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "slug",
      +                "locale",
      +                "title",
      +                "order",
      +                "body"
      +              ],
      +              "type": "object"
      +            },
      +            "content_locale": {
      +              "enum": [
      +                "de",
      +                "en",
      +                "es"
      +              ],
      +              "type": "string"
      +            },
      +            "fallback": {
      +              "type": "boolean"
      +            },
      +            "id": {
      +              "type": "string"
      +            },
      +            "requestedLocale": {
      +              "enum": [
      +                "de",
      +                "en",
      +                "es"
      +              ],
      +              "type": "string"
      +            },
      +            "status": {
      +              "anyOf": [
      +                {
      +                  "enum": [
      +                    "draft",
      +                    "candidate",
      +                    "active",
      +                    "deprecated"
      +                  ],
      +                  "type": "string"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "updated": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "version": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "requestedLocale",
      +            "content_locale",
      +            "fallback",
      +            "version",
      +            "status",
      +            "updated",
      +            "content"
      +          ],
      +          "type": "object"
      +        },
      +        "success": {
      +          "const": true
      +        }
      +      }
      +    },
      +    {
      +      "properties": {
      +        "errors": {
      +          "minItems": 1
      +        },
      +        "result": {
      +          "type": "null"
      +        },
      +        "success": {
      +          "const": false
      +        }
      +      }
      +    }
      +  ],
      +  "properties": {
      +    "errors": {
      +      "items": {
      +        "additionalProperties": true,
      +        "properties": {
      +          "code": {
      +            "type": "number"
      +          },
      +          "documentation_url": {
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "hint": {
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "message": {
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "slug": {
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "code",
      +          "slug",
      +          "message",
      +          "hint",
      +          "documentation_url"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "messages": {
      +      "type": "array"
      +    },
      +    "request_id": {
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "result": {},
      +    "success": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success",
      +    "result",
      +    "errors",
      +    "messages",
      +    "request_id"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so safety behavior is covered. The description adds only that the playbook must exist and be public; it says nothing about authorization, not-found behavior, or response shape. A 3 is appropriate because the annotations carry most of the behavioral burden.

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?

A single sentence with no wasted words, and the core action is front-loaded. It is appropriately terse for a simple read-by-ID tool, though it could have added the list-vs-single routing hint in the same breath.

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?

An output schema exists, so return values need not be described, and annotations cover safety. However, the description omits the distinction from academy_playbooks and does not clarify what the required id refers to. For a simple retrieval tool this is minimally adequate but leaves clear gaps.

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 67%, with locale and idempotencyKey documented as transport fields but the required id parameter lacking a description beyond its pattern. The tool description adds no further meaning about the id format or locale selection. Baseline 3 reflects that the schema does most of the work while the primary identifier remains semantically thin.

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: 'Read' an 'existing public playbook.' This distinguishes it from write operations and implies the plural sibling academy_playbooks is for listing, though the description never names that alternative explicitly.

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?

Gives no explicit guidance on when to use this tool versus academy_playbooks or academy_search. The reader can infer it retrieves a single playbook by ID, but there are no stated preconditions, exclusions, or alternatives.

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.