kingdee_query_system_config

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

Annotations already indicate read-only, non-destructive, and idempotent behavior. The description adds that it returns a JSON format list but does not disclose any additional traits or limitations beyond what annotations provide.

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 reasonably concise and starts with purpose. It uses bullet points for examples, which aids readability. However, it could be slightly more structured, e.g., grouping return info.

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 that an output schema exists, the description adequately explains inputs and output format. It mentions pagination parameters implicitly via examples? Actually no, but the schema covers them. Overall, it covers the essential information for a config query tool.

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 has descriptions for filter_string and field_keys, but the tool description adds value by providing concrete examples and recommended field_keys. It also clarifies the return format. For the other parameters (start_row, limit), the description does not add meaning, but they are straightforward.

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 queries system config parameters in Kingdee. It provides specific examples of filter_string and field_keys, and mentions the return is a JSON list. This distinguishes it from sibling query tools which query 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 gives examples of filter strings and field keys, implying common usage. However, it does not explicitly state when to use this tool versus alternatives, nor does it provide prerequisites or conditions where the query might fail.

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