kingdee_query_role

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds that the tool returns a JSON formatted role list, but does not disclose additional behavioral traits beyond what annotations provide. For a read-only tool with good annotations, this is adequate.

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 extremely concise: two sentences for purpose and examples, plus a note on return type. Every sentence adds value, and it is front-loaded with the primary action.

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?

The tool is moderately complex with 4 parameters, and an output schema exists. The description covers the essential usage patterns (filtering, field selection) and states the return format. It does not explain pagination (start_row, limit) or error behavior, but these are partially covered by the schema. Overall adequate.

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?

Given schema description coverage is 0% per context (though schema actually has descriptions like '过滤条件'), the description compensates by providing concrete examples for filter_string and recommending field_keys. This adds significant meaning beyond the bare schema, especially for filter syntax.

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 tool's purpose: '查询金蝶系统中的角色列表' (query the role list in Kingdee system). This specifies the verb (query) and resource (role list), distinguishing it from sibling query tools for other entities.

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 provides practical usage examples for filter_string and recommended field_keys, aiding parameter usage. However, it lacks explicit guidance on when to use this tool versus alternatives (e.g., other query tools for different entities). The purpose is clear from the name, but no direct comparison or usage context is given.

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