gitee_list_repo_issue_comments

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

With no annotations, the description carries full burden but only states 'List', implying read-only. It does not disclose pagination behavior (though schema hints), rate limits, required permissions, or that it returns an array of comments. Minimal behavioral disclosure.

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 a single, short sentence (7 words), front-loaded with the core action. However, it is slightly too terse and could benefit from a brief note on siblings or parameters without losing conciseness.

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?

Given 7 parameters, no output schema, and related sibling tools, the description is insufficient. It doesn't explain what is returned (e.g., list of comment objects), how pagination works, or how to filter by issue. Leaves significant gaps for effective 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?

Schema description coverage is 100%, so baseline is 3. The description adds no additional meaning beyond the schema; it doesn't explain the 'since' parameter format or the effect of sort/direction enums.

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 states 'List all issue comments for a repository', clearly specifying the action (list), resource (issue comments), and scope (repo). However, it does not differentiate from sibling tools like gitee_list_issue_comments (likely per issue) or gitee_get_issue_comment (single comment), leading to potential ambiguity.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., gitee_list_issue_comments for a specific issue). The description lacks any context about prerequisites, filters, or best practices.

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