nexus_get_comment

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

Annotations already establish readOnlyHint, idempotentHint, and destructiveHint=false. The description adds value beyond annotations by disclosing the rate-limit behavior ('does NOT consume the v1 REST rate-limit quota') and listing the exact JSON return fields. This is useful operational context for an agent.

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 concise and front-loaded with the primary action. The rate-limit note is valuable and the return field list is clearly structured. It is slightly redundant with the output schema, but it does not waste words.

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-parameter read tool, the description is complete: it states the purpose, API version, rate-limit implications, and return shape. Annotations cover safety/idempotency, and an output schema exists, so nothing needed to invoke the tool correctly is missing.

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 schema provides 100% coverage with 'comment_id' described as 'Comment ID.', so the description does not need to add much. The description only reinforces that lookup is 'by ID' and does not add deeper semantic detail about the parameter, but the high schema coverage makes this acceptable.

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 opens with 'Get a single comment by ID', a specific verb plus resource, and identifies the API version ('v2 GraphQL'). This clearly distinguishes it from related tools like nexus_get_comment_thread or nexus_search_comments.

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 gives clear context: use this for a single comment lookup by ID, and it adds the practical note that it uses v2 GraphQL and does not consume the v1 REST rate-limit quota. It does not explicitly name alternatives or exclusions, but the purpose is specific enough that an agent can infer when to choose it.

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