getRecentPullRequests

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

With no annotations, the description takes on the burden. It discloses sort order ('most recent first'), the presence of state under meta.state as conditional ('when the connector recorded it'), and the inability to pre-filter by state. This gives useful behavioral context beyond a simple 'list' statement.

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 sentences, 39 words, with the main action front-loaded. Every sentence contributes either the core functionality or a key filtering caveat. No fluff.

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 tool has only 2 optional params, no annotations, and no output schema. The description explains ordering and the state field, but leaves the 'service' parameter and the term 'connector' undefined. It's adequate for a simple list tool but has clear gaps.

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 input schema has 0% description coverage, and the description does not mention 'limit' or 'service'. While 'limit' is self-explanatory, 'service' is ambiguous (which service? what values?). The description adds no meaning to the parameter names, leaving the agent to guess.

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 uses a specific verb and resource: 'List recent pull requests from the local index'. It clearly distinguishes this from sibling tools like getRecentDeployments or getDoraMetrics by naming a unique resource (pull requests).

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 mentions a limitation ('the index cannot pre-filter by PR state') but provides no explicit guidance on when to use this tool vs siblings. It does not say, for example, 'use searchIndex for broader searches' or any alternative scenario.

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