Skip to main content
Glama

UGT: Use the GitHub Thing

Read a recipe file

read_recipe_file
Read-onlyIdempotent

Read one of a recipe's files, such as compose.yaml, its Dockerfile or recipe.json, to see exactly what it runs. get_recipe lists its files.

Input Schema

NameRequiredDescriptionDefault
pathYesThe file's path in the recipe, as get_recipe lists it.
recipeYesA recipe's ID, owner/repo/task, such as openai/whisper/subtitles.

Output Schema

NameRequiredDescriptionDefault
pathYes
sizeYes
textYes
recipeYesA recipe's ID, owner/repo/task, such as openai/whisper/subtitles.
revisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

The annotations already establish that this is a safe, read-only, idempotent operation. The description adds useful context about inspecting executable recipe content, but does not disclose behavioral details such as size limits, truncation, or handling of unsupported files.

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?

Two compact sentences front-load the operation, scope, examples, and purpose, then provide file-discovery guidance. There is no redundant or unnecessary wording.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter read tool, the description supplies the essential purpose and discovery workflow. Fully documented inputs, comprehensive safety annotations, and an output schema cover the remaining invocation needs.

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%, including the recipe ID format and the requirement to use a path as listed by get_recipe. The description’s filename examples add a little context, but it largely repeats rather than expands the parameter guidance.

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?

“Read one of a recipe’s files” gives a specific verb, resource, and scope, while examples such as compose.yaml and recipe.json clarify the available content. Mentioning that get_recipe lists files also distinguishes this content-retrieval tool from its closest sibling.

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?

The phrase “to see exactly what it runs” supplies a concrete inspection use case, and “get_recipe lists its files” guides agents to the sibling tool for file discovery. It does not explicitly state exclusions or when other siblings are preferable, but the routing guidance is clear.

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.