Get Git Overview

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds the behavioral detail that it uses pod exec and returns a specific failure format, which provides value beyond the annotations.

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 two concise sentences with no wasted words. The key method (pod exec) and distinguishing factor (ground truth) are front-loaded, making it efficient and easy to parse.

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?

The description explains failure conditions but omits the success response format and provides no parameter guidance. For a tool with 5 parameters and no output schema, this is incomplete; an agent would struggle to construct a correct call, especially for env, limit, and region.

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?

The description provides no parameter semantics. With schema description coverage at 0%, the description fails to compensate for the undocumented parameters (env, limit, region). An agent has no guidance on how to fill these fields beyond their names and types.

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 states a specific verb ('reads'), a specific resource ('repository'), and the method ('pod exec'), and explicitly distinguishes it from the deploy record. This makes the tool's purpose clear and distinct from sibling tools like getGitDiff or listBranches.

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 description implies the primary use case (ground truth over deploy record) and specifies failure conditions, which helps an agent decide when to call it. However, it does not explicitly name alternative tools or state when not to use it, so the guidance is inferred rather than explicit.

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