Skip to main content
Glama

Read a workflow reference file

get_workflow_file
Read-only

Read one reference file of a workflow, e.g. {workflow:"vidguy-edit", path:"references/captions.md"}. Only the .md paths listed by get_workflow_instructions work. Open each once, at the stage that needs it. Files over 64 KB come in pages: when the result ends with a "continue with offset" line, call again with that offset for the next page. Free, read-only.

Input Schema

NameRequiredDescriptionDefault
pathYesRelative .md path from get_workflow_instructions' files
offsetNoByte offset of the page to read (from the previous page's nextOffset). Omit for the first page
workflowYesWorkflow id, e.g. "vidguy-edit"

Output Schema

NameRequiredDescriptionDefault
pathNo
contentNo
workflowNo
nextOffsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Byte offset of the page to read (from the previous page's nextOffset). Omit for the first page",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / nextOffset
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "number"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
  2. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare read-only and non-destructive behavior, so the description adds value by explaining pagination: files over 64 KB require paginated calls when a 'continue with offset' line appears. It also notes 'Open each once' (avoid redundant reads) and 'Free,' which is useful cost context beyond annotations.

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 short and front-loaded: purpose first, example second, constraints and pagination guidance last. Every sentence carries useful information with no redundancy or filler.

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?

Given the output schema exists and annotations cover the safety profile, the description is complete enough. It explains the sibling dependency, usage timing, pagination behavior, and cost, leaving no critical gap for correct invocation.

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 100%, so the schema already documents all three parameters. The description adds meaning by linking the offset parameter to the pagination continuation line in the result, and the example demonstrates valid workflow and path values. This goes slightly beyond the schema.

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?

The description states a specific verb and resource: 'Read one reference file of a workflow.' It provides a concrete example and distinguishes this from the sibling get_workflow_instructions by noting only paths listed there work. An agent can identify exactly what this tool does.

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?

It gives clear context: use it at the stage that needs the reference file, and only for .md paths listed by get_workflow_instructions. It doesn't explicitly name when not to use it, but the prerequisite and contextual cue are strong enough for correct selection.

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