Skip to main content
Glama

Read Recipe Authoring Guidance

get_recipe_authoring_guidance
Read-onlyIdempotent

Read versioned authoring rules and matched archetype guidance for one private build.

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": {
      "build_ref": "<build_ref>"
    },
    "name": "get_recipe_authoring_guidance"
  }
}

Input Schema

NameRequiredDescriptionDefault
build_refYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world behavior, so the bar is lower. The description adds useful context that the returned rules are version-pinned and archetype-matched, but it does not disclose behavior when no archetype matches or what 'private' implies for access permissions.

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?

The whole definition is a single front-loaded sentence with no filler, and the resource is stated before the scope. It is efficient but so terse that key information is omitted rather than compressed.

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 and annotations are rich, so return values and safety are covered elsewhere. However, for a single-required-parameter tool with 0% schema description coverage, the definition leaves the meaning and constraints of build_ref, and the conditions under which guidance is unavailable, unexplained.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the full burden for build_ref, yet 'one private build' is all the meaning it adds. The description does not say whether build_ref is an ID, name, or path, that it must reference an existing private build, or what happens for a nonexistent or public build.

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 names a concrete verb and resource (read versioned authoring rules and matched archetype guidance) and scopes it to a single private build, which separates it from the many sibling get_recipe_* readers that fetch builds, contracts, schemas, or activity. It stops short of naming a sibling it is not, so it lands at 4 rather than 5.

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?

Usage is only implied: the phrase 'authoring rules ... for one private build' suggests it is consulted while authoring or validating a recipe build. There is no explicit when-to-use, no when-not-to-use, and no routing to alternatives such as get_recipe_acceptance_plan or get_recipe_build_schemas.

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