get_workflow

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only restates the operation without mentioning side effects, authorization requirements, rate limits, or handling of non-existent workflows. The docs link is helpful but not embedded behavioral context, so the description adds no transparency beyond the function's name.

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?

The description is extremely concise: one sentence of pure purpose plus a documentation URL. It is front-loaded, contains no redundant phrasing, and every word contributes. This is an efficient and well-structured description.

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?

For a simple, read-only GET operation with fully described parameters, the description is adequate. It clearly identifies the resource and how to reference it. The lack of an output schema is compensated by the general familiarity of GitHub workflows, and the docs link provides further detail. Minor gap: it doesn't mention the return format, but this is not critical for such a straightforward tool.

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 100%, with each parameter (owner, repo, workflow_id) having a clear description. The tool description adds no extra meaning beyond the schema, such as clarifying the workflow_id parameter's dual nature, which is already documented. Baseline 3 applies because the schema fully carries the parameter semantics.

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 clearly states 'Get a workflow by ID or filename,' which specifies the verb, resource, and scope. It effectively distinguishes this from sibling tools like 'list_workflows' (which lists all workflows) and 'get_workflow_run' (which gets a specific run, not the workflow definition).

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 usage is implied: you use this tool when you have a workflow ID or filename. However, it does not explicitly state when not to use it or mention alternatives like 'list_workflows' for when you lack an identifier. It provides no direct guidance on tool selection, but the scope is reasonably clear.

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