github_get_workflow_run

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

No annotations. Description only mentions routing and authentication scope but fails to disclose read-only nature, required permissions, or any side effects. No behavioral traits beyond the generic request context.

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?

Very short but wastes space on tautological name repetition and routing details. Lacks substantive information. Every sentence does not earn its place.

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?

Despite having an output schema, the description omits any explanation of what the tool does. A complete description would clarify that it retrieves details of a specific GitHub workflow run. The current description is incomplete.

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 coverage is 0%. The description notes 'arguments: JSON string of arguments for the connector operation,' which adds minimal meaning but does not specify expected keys or structure for the JSON string.

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 merely restates the tool name and platform path. Does not specify what a workflow run is or what the tool retrieves. No verb or resource clarification.

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?

No guidance on when to use this tool versus siblings like github_list_workflow_runs or github_get_workflow_run_logs. No context provided.

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