getPRTemplate

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

Describes the tool as generating markdown from commits and diff stats, consistent with readOnlyHint annotation. Adds context about data source (commits and diff stats) and output format (markdown). No contradictions.

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 concise sentences with no unnecessary words. Front-loaded with purpose and includes key workflow hint. Excellent structure.

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 simple tool with two optional parameters and no output schema, the description fully explains behavior, input, and output. Includes integration hint for downstream tool, making it complete for agent use.

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?

Input schema has 100% coverage with clear descriptions for both parameters. Description does not add additional meaning beyond schema, but provides context about output usage. Baseline 3 is appropriate.

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?

Description clearly states the tool generates PR descriptions from commits and diff stats vs base branch. Differentiates from sibling fetchGithubPR by specifying it produces new content (markdown) to be passed to another tool.

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?

Explicitly says to pass output to githubCreatePR, indicating usage in PR creation workflow. However, does not provide explicit when-not-to-use or mention alternative tools like fetchGithubPR for existing PRs.

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