gitee_check_gist_starred

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

The description lacks behavioral details. It does not disclose that the tool is read-only, what the return value indicates (e.g., boolean), or any prerequisites like authentication. With no annotations, this leaves agents guessing.

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 concise sentence that is easily parsed. It is front-loaded and efficient. However, its brevity omits important contextual details that could be included 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 no output schema, the description should hint at the return value (e.g., boolean or status). It also lacks context on whether the gist must exist or if the user must own the gist. The description is incomplete for a check operation.

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 covers 100% of parameters with a description 'Gist ID' for the 'id' parameter. The description adds no extra context beyond the schema, such as format or examples. Baseline score of 3 applies due to full schema coverage.

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 the verb 'Check' and the resource 'gist is starred'. It conveys the primary purpose without ambiguity. However, it does not differentiate from sibling tools like gitee_list_starred_gists or gitee_get_gist, which might also provide starred status.

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 given on when to use this tool versus alternatives. For example, there is no mention that this tool checks a single gist, while gitee_list_starred_gists lists all starred gists, or that gitee_star_gist/unstar_gist modify the starred state.

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