workflows_overview

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

With no annotations, the description carries the burden well: it discloses that secret values are never read (only names), that invalid YAML is reported with a line number rather than failing, and that local composite actions are included. It never explicitly says the operation is read-only or requires no authentication, which keeps it from a 5.

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?

Front-loaded with the scope enumeration and closed with the actionable 'Start here', with no filler. The middle sentences are dense and run long, but every clause adds real information about coverage or behavior.

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?

An output schema exists, so return-value explanation is unnecessary, and the description covers scope, input forms, and error behavior for a fairly complex analysis tool. The missing pieces are minor: no explicit read-only assurance and no mention of the '.' default, both of which an agent would otherwise have to infer.

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, and it does: `path` is defined as a workflow file, a repo root containing .github/workflows, or the workflows directory. The default value of '.' is never mentioned and no example path is given, so a small gap remains.

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?

States a specific verb (Summarize) and resource (GitHub Actions workflows) and then enumerates exactly what is covered: triggers, jobs with runners and needs, per-job permissions, actions with pin status, environments, secret names, and local composite actions. An agent knows precisely what this returns without opening the schema.

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 closing 'Start here' gives clear entry-point guidance that positions it ahead of the sibling tools (lint_workflows, job_graph, permissions_review, etc.), and the path sentence explains the three accepted input shapes. It stops short of naming any sibling or saying when to prefer a narrower tool, so it falls short of a 5.

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