Skip to main content
Glama

rh_validate_workflow

Validate a local workflow revision's structural, runnable, and backend-compatibility state. Use it to check workflow JSON before running jobs.

Instructions

Return structural, runnable, and backend-compatibility states for a local workflow revision.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
revision_idNo
workflow_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose the conceptual contents of the response (structural, runnable, and backend-compatibility states), which partially substitutes for the missing output schema. However, it never states that the operation is read-only/non-destructive, whether it touches the backend or is purely local, or what happens on invalid input, so the safety and side-effect profile must be assumed from the name alone.

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?

A single tight sentence with no filler, and the object of the operation is front-loaded before the qualifier. Every word earns its place.

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

Completeness2/5

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

For a tool with no annotations, no output schema, and zero documented parameters, the description covers only the return semantics and leaves prerequisites, distinguished siblings, and parameter meaning unaddressed. An agent would struggle to call this correctly without opening the schema and guessing at the workflow/revision distinction.

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% for both parameters, and the description supplies no meaning for workflow_id or revision_id beyond the vague phrase 'local workflow revision'. It does not explain that revision_id is optional, what a revision is relative to a workflow, or the expected ID format.

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 gives a specific verb (return) and resource (structural, runnable, and backend-compatibility states for a workflow revision), so the agent knows this is a validation/reporting operation rather than a mutation. It is clear on its own, but it never distinguishes itself from the sibling rh_validate_payload or from rh_get_workflow, leaving the agent to guess which validation entry point to call.

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?

There is no when-to-use statement, no prerequisites, and no mention of alternatives such as rh_validate_payload or rh_run_workflow. The agent must infer the context entirely from the name.

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