kingdee_query_sequence

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds that it returns a JSON list of sequence rules, which is consistent and provides return format context. No contradictions.

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 succinct: one line for purpose, two example usages, a line for recommended fields, and the return type. Every sentence adds value without redundancy.

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 the presence of annotations, input schema with parameter descriptions, and an output schema (implied), the description supplements with practical examples and recommended fields. It does not cover error handling or pagination, but those are addressed by schema (start_row, limit). Adequate for a 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 provides parameter descriptions in Chinese, but the tool description adds practical examples (e.g., 'FObjectType=\'PUR_PurchaseOrder\'' for filter_string) and recommended field_keys, which enhances understanding beyond the schema alone.

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 resource (编码规则/SequenceRule) and action (查询/query). It provides specific examples of filter_string and field_keys, distinguishing it from other query tools like kingdee_query_bills. The title annotation '查询编码规则' reinforces the purpose.

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 common filter_string usage examples and recommends specific field_keys, guiding the agent on effective usage. However, it lacks explicit when-not-to-use or comparison with siblings like kingdee_query_number_rule, but the name and context make it clear this is the dedicated tool for sequence rules.

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