github_list_deployments

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

No annotations are provided, and the description only notes routing and authentication. It fails to disclose read-only behavior, rate limits, or response size implications, leaving the agent with minimal behavioral insight.

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 short (three sentences) but wastes space on routing details ('Routes through /api/tools/invoke under your JWT, tenant, and company scope') that are likely generic. It achieves conciseness but not informativeness.

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 tool's purpose (list deployments) and the presence of an output schema, the description should at least mention what is returned (e.g., 'Returns a list of deployments') and hint at required arguments. It does neither, leaving the agent underinformed.

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 coverage is 0%, yet the description only restates the schema property ('arguments: JSON string of arguments') without specifying expected fields like repository, owner, or pagination. This adds no meaning beyond the schema.

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 merely restates the tool name as 'Github connector operation `list_deployments`', providing no explanation of what deployments are or what listing them entails. It adds no value beyond the name itself.

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 on when to use this tool versus other GitHub list tools (e.g., list_pull_requests, list_releases). The description lacks context for appropriate selection.

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