get_commit_detail

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

With no annotations, the description clarifies the tool is for retrieval and specifies the output types. It does not mention authentication or rate limits, but for a read-only tool this is acceptable.

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?

Two short, front-loaded sentences with no wasted words. The critical information is presented first.

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 4 parameters (all documented), no output schema, and no annotations, the description adequately covers the tool's behavior. It could mention output format variations, but the detail enum compensates.

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 100%, so each parameter is already described. The description adds only brief context about the detail parameter's purpose, not significantly 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 clearly states it gets details of a specific commit, listing three specific detail levels (metadata, files, diff). This directly distinguishes it from sibling tools like get_repo_commits (list) and get_pull_request_diff.

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 advises using the detail level to control output size, which implies when to choose each level. However, it does not explicitly state when to use this tool over alternatives like get_pull_request_diff for commit diffs.

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