get_pull_request

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

No annotations are present, so the description carries the burden. 'Read-only' is explicitly stated, which is a valuable behavioral trait for the agent. However, it does not disclose rate limits or other quirks, though the output schema likely covers return structure, making a 4 appropriate.

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 one short sentence with no filler. It is front-loaded with the core purpose and the read-only note, making it maximally concise and well-structured.

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 single-resource getter, the description is mostly adequate, especially with an output schema present. However, it lacks usage guidance and parameter semantics, leaving the agent to infer those from the tool name and sibling context. It is complete enough to use correctly 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?

Schema description coverage is 0%, and the description does not compensate by explaining the parameters. While the parameter names are self-explanatory, the description adds no meaning beyond the schema. Given the low coverage, the description should have provided some parameter context but does not.

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 'Get detailed metadata for one GitHub pull request' clearly states the action and resource. It distinguishes from sibling list_pull_requests by specifying 'one' pull request and 'detailed metadata', so the purpose is unambiguous.

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 usage for fetching a single PR's metadata but provides no explicit when-to-use guidance or alternatives. It does not mention when not to use or contrast with list_pull_requests or other similar tools, so the guidance is only implied.

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