Skip to main content
Glama

get_workflow

Parse a workflow YAML file and retrieve its complete structure for inspection or further processing.

Instructions

Read and parse a workflow YAML file, returning its full structure.

Args:
    yaml_path: Path to the YAML workflow file

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
yaml_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

No annotations provided. Description implies read-only behavior by stating 'Read and parse', but does not detail side effects, error handling, or permissions. Adequate for a simple read tool but minimal.

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?

Extremely concise: two sentences. The Args line is redundant with schema but not harmful. No fluff, though could briefly mention that it's a safe read operation.

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?

Given simple single-param tool and existence of output schema, description covers main action. Lacks mention of error conditions (e.g., invalid YAML, file not found), but return values are in output schema. Good enough for a basic tool.

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%. The description adds only 'Path to the YAML workflow file' for the parameter, which restates the type and name. Does not specify format, relative vs absolute, or constraints.

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?

Description uses specific verb 'Read and parse' and resource 'workflow YAML file' with clear outcome 'returning its full structure'. Clearly distinguishes from siblings that create, validate, run, or list workflows.

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

Usage Guidelines2/5

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

No guidance on when to use vs alternatives like list_workflows or validate_workflow. No mention of prerequisites (e.g., file must exist) or when not to use.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ksterx/srunx'

If you have feedback or need assistance with the MCP directory API, please join our Discord server