read_discussion

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

No annotations provided; description discloses return structure (title, body, comments with author/date) and implies read-only nature. Does not detail error handling or permissions, but adequate for a simple read operation.

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?

Three sentences: purpose, usage guidance, parameter description. Front-loaded, no fluff, each sentence serves a clear function.

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?

Covers purpose, usage, and return content. With output schema present, description doesn't need full return specs. Lacks mention of potential pagination or errors, but sufficient for the tool's simplicity.

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?

Single parameter discussion_number is explained with 'The discussion number (from pull_discussions),' providing origin context beyond the schema's type definition. Schema description coverage is 0%, so description adds significant value.

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 'Read the full content of a discussion' with verb and resource, distinguishing it from siblings like pull_discussions and add_to_discussion.

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?

Provides explicit guidance: 'Use this to understand what has been said before contributing,' implying when to use it relative to sibling tools. Lacks explicit when-not or alternatives but context is clear.

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