github_get_workflow_logs

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

With no annotations, the description carries full burden. It discloses that logs are parsed and returned as structured per-job logs with error extraction, which is useful. However, it does not mention potential limitations, authentication requirements, or failure behavior, leaving gaps in transparency.

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?

Two sentences, front-loaded with the core action, and no filler. Every word contributes to understanding the tool's purpose and output.

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 the simple parameter set and lack of output schema, the description reasonably conveys that the return is structured per-job logs with error extraction. It could detail the structure further, but it is adequate for an agent to understand what to expect.

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?

The input schema already documents all three parameters (owner, repo, runId) with 100% coverage. The description adds no extra parameter-level meaning beyond restating that logs are retrieved for a specific run, so it meets the baseline without adding value.

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?

The description uses specific verbs ('Retrieve and parse') and a clear resource ('execution logs for a specific workflow run'). It clearly distinguishes itself from siblings like github_get_workflow_run by focusing on logs rather than run metadata.

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 'for a specific workflow run' implies the need for a run ID and a scenario where logs are required. However, it does not provide explicit guidance on when to prefer this tool over alternatives like github_analyze_failure or github_get_workflow_run, leaving the choice somewhat implicit.

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