gitee_list_branches

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

No annotations are provided, and the description does not disclose behavioral traits. It is a read operation, but the description fails to mention that it returns a list of branch objects, any pagination behavior, or the default ordering. The burden is on the description, and it is insufficient.

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 very concise with one sentence. It is front-loaded with the essential action. However, given the lack of detail, it could be slightly expanded to include key information 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?

No output schema exists, so the description should compensate by explaining the return structure. It does not. Pagination behavior (e.g., default page size, maximum) is also missing. For a listing tool, this is inadequate for an agent to invoke correctly.

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 coverage is 100%, so the baseline is 3. The description adds no extra meaning beyond what the schema provides. Parameters like 'page' and 'per_page' are already described in the schema, and the description does not clarify their usage or constraints.

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 'List repository branches' clearly states the verb and resource. It implies listing all branches, differentiating from the sibling 'gitee_get_branch' which retrieves a single branch. However, it could explicitly mention that it returns all branches for the repository.

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 like 'gitee_get_branch', 'gitee_create_branch', or other branch operations. There is no mention of pagination, sorting, or typical use cases. The agent receives no context for decision-making.

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