Skip to main content
Glama

Recipe Schema

recipe_schema
Read-only

Returns a registered recipe's declared input schema, including parameter types, units, defaults, ranges, choices, and outputs, so parametric regeneration can be authored against its exact contract.

Instructions

Return one recipe's declared INPUT SCHEMA — its driving parameters with type/unit/default/range. Returns {schema, recipe, doc, inputs:[{name, type, unit?, default?, min?, max?, required, choices?, doc?}], emits}. recipe names a registered recipe; an unknown name fails loudly. This is the contract a parametric regeneration is authored against.

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": {
      "recipe": "<recipe>"
    },
    "name": "recipe_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
recipeYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds genuine value beyond that by disclosing the exact return envelope ({schema, recipe, doc, inputs[], emits}) and the failure mode for an unknown recipe name. It stops short of describing whether schemas are cached or versioned, but the added behavioral detail is substantial.

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?

Front-loaded with the core purpose, then the return shape, then the failure mode. The inline field list mirrors the schema somewhat redundantly and the prose is jargon-dense, but no sentence is wasted and length suits the tool.

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 takes on the burden of describing return values and does so explicitly. Combined with annotations covering read-only semantics and the explanation of the undocumented `recipe` parameter, an agent has enough to call this correctly; only edge cases like empty schemas or recipe versioning are unaddressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50% — `workspace` is documented in the schema but `recipe` is bare. The description compensates by explaining that `recipe` must name a registered recipe and that an unknown name fails loudly, which is meaningful semantics the schema does not carry.

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 — 'Return one recipe's declared INPUT SCHEMA' — and immediately scopes it to driving parameters with type/unit/default/range. This is clearly distinguishable from siblings like recipe_list (enumeration), recipe_validate (checking), and feature_schema (different resource family).

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?

The closing line, 'This is the contract a parametric regeneration is authored against,' implies when to reach for it, and 'an unknown name fails loudly' warns about bad input. However, no sibling is named as an alternative and there is no explicit when-not-to-use guidance (e.g., versus recipe_validate or feature_schema).

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

Deploy Server

Other Tools