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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered and this is a lower bar. The description adds value by naming what the result contains (repo, branch, auto-pull), which matters because there is no output schema, but it says nothing about what happens when no GitHub source is linked.

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?

One compact sentence that front-loads the purpose and lists the payload fields without filler. It is arguably too terse given the undocumented parameter, but nothing in it is wasted.

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?

Because there is no output schema, the field list (repo, branch, auto-pull) does useful work in describing the return. However a read tool with an undocumented required identifier and no guidance on the unlinked-source case leaves an agent short of what it needs to call it confidently.

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% for the single required 'id' parameter, and the description does not clarify whether it is a deployment ID, an app ID or a slug. With the only parameter undocumented in both schema and prose, the description fails to compensate for the coverage gap.

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 gives a specific verb and resource ('Get the linked GitHub source') and enumerates the returned facets (repo, branch, auto-pull), which lets an agent tell it apart from the general deployments_get or the mutating deployments_setAutoPull. It stops short of naming those siblings explicitly, so differentiation is inferred rather than stated.

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?

There is no when-to-use guidance, no preconditions (e.g. that the deployment must have a GitHub link), and no mention of the obvious alternative deployments_setAutoPull for changing the auto-pull flag. The agent must guess the context from the name alone.

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