Link Github Integration

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the mutation is known, but the description adds no behavioral context beyond that. It does not mention side effects, idempotency, prerequisites, or whether an existing integration is replaced.

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 a single clear sentence with no wasted words, but it essentially restates the tool name and carries no additional structural information. It is concise but under-specified.

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 destructive, open-world mutation with a nested request body and no output schema, this description is too thin. It lacks prerequisites, side effects, and any guidance on how the GitHub installation link behaves within a workspace.

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 50% and the only parameter description is the generic 'The JSON request body.' The description adds only a loose semantic mapping (installation → workspace) and does not explain installationId or workspaceSlug meaning, formats, or relationships.

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 names a specific verb ('Link'), a resource ('GitHub installation'), and a target ('workspace'). This distinguishes it from sibling tools like disconnectGithubIntegration and listGithubRepos, though it does not explicitly call out any alternative.

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 is given on when to use this tool versus alternatives such as listWorkspaceIntegrations or disconnectGithubIntegration. The intended use case is only implied by the verb 'Link', with no exclusions or contextual conditions.

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