get_workflow_run

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

Annotations declare readOnlyHint=true, which already establishes the safety profile, and the description is consistent with that. No additional behavioral traits such as error behavior, rate limits, or auth requirements are disclosed, but none are necessary for this simple getter.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

A single declarative sentence with no filler words. It is front-loaded with the verb and noun, and every word contributes to the meaning.

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

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

Given that the tool is a straightforward read operation, annotations cover the read-only nature, and an output schema exists, the description is nearly complete. The only minor gap is the absence of a pointer to list_workflow_runs as the way to discover run IDs.

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

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

Schema description coverage is 0%, so the description must compensate. It clarifies that run_id is the workflow run identifier, while owner and repo are left to their conventional and self-explanatory names. This is adequate but not detailed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Description uses specific verb 'Get', names the resource 'Actions workflow run', and scopes to a single run by ID. This clearly distinguishes it from list_workflow_runs and dispatch_workflow even without naming them.

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

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

The phrase 'by ID' implies the tool is used when a specific run_id is known, and it contrasts with listing runs. However, it provides no explicit guidance on when to prefer this over list_workflow_runs or any exclusions.

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