Skip to main content
Glama

academy_recipe

Read-onlyIdempotent

Fetch a public recipe by ID for academy use; private recipes remain undiscoverable.

Instructions

Read a public recipe; private recipes remain undiscoverable.

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. Changed8 schema fields changedv0.6.0
    • 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
      Added value: +{
      +  "default": "de",
      +  "description": "MCP transport locale; not a service input field.",
      +  "enum": [
      +    "de",
      +    "en",
      +    "es"
      +  ],
      +  "type": "string"
      +}
    • 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"
      +                },
      +                "contentHash": {
      +                  "type": "string"
      +                },
      +                "meta": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "description": {
      +                      "type": "string"
      +                    },
      +                    "duration": {
      +                      "type": "string"
      +                    },
      +                    "order": {
      +                      "type": "number"
      +                    },
      +                    "phase": {
      +                      "maximum": 16,
      +                      "minimum": 1,
      +                      "type": "integer"
      +                    },
      +                    "published": {
      +                      "type": "string"
      +                    },
      +                    "slug": {
      +                      "type": "string"
      +                    },
      +                    "tags": {
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "title": {
      +                      "type": "string"
      +                    },
      +                    "updated": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "slug",
      +                    "phase",
      +                    "order",
      +                    "title",
      +                    "description",
      +                    "duration"
      +                  ],
      +                  "type": "object"
      +                },
      +                "steps": {
      +                  "items": {
      +                    "additionalProperties": false,
      +                    "properties": {
      +                      "body": {
      +                        "type": "string"
      +                      },
      +                      "index": {
      +                        "type": "number"
      +                      },
      +                      "title": {
      +                        "type": "string"
      +                      },
      +                      "validatorId": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "required": [
      +                      "index",
      +                      "title",
      +                      "body"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "required": [
      +                "meta",
      +                "body",
      +                "steps",
      +                "contentHash"
      +              ],
      +              "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. Addedv0.4.1

TDQS

A3.8/5.0
Behavior4/5

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

The annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so the description does not need to repeat that. It adds a meaningful access constraint by stating that only public recipes are readable and private recipes remain undiscoverable.

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?

The description is a single front-loaded sentence with no wasted words. The key scope constraint is stated immediately.

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?

An output schema exists and annotations cover the safety profile, so return behavior and mutation risk need not be explained. The description covers public/private access but leaves the required id semantics and sibling alternatives 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 67%; the transport parameters are documented, but the required 'id' parameter has no schema description. The description only implies that 'id' identifies a public recipe, adding little beyond the schema pattern.

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?

The description gives a specific verb and resource ('Read a public recipe') and clarifies that private recipes are excluded. It does not explicitly distinguish this single-recipe reader from the sibling list tool academy_recipes, but the scope is otherwise clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It implies usage for public recipes and warns that private recipes cannot be discovered, which is useful context. However, it does not name alternatives such as academy_recipes or academy_search or explain when to choose this tool over them.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.