pospal_list_products

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

No annotations exist, so the description must disclose behaviors. It only notes HTML parsing into structured data but omits auth requirements, rate limits, error handling, or any side effects. The minimal text does not adequately inform the agent of behavioral nuances.

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 single-sentence description is concise but lacks structure. It does not front-load critical information or separate purpose from implementation detail. While not verbose, it sacrifices necessary detail for brevity.

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?

With 4 parameters, no annotations, and an existing output schema, the description should explain parameter usage and behavior. It only covers pagination vaguely, leaving 'enable' and 'keyword' ambiguous. The output schema may document return values, but parameter ambiguity remains.

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 description coverage is 0%, yet the description adds no meaning for parameters like 'enable' or 'keyword'. The pagination parameters are implied by '分页', but the other two remain unexplained. The description fails to compensate for the lack of schema documentation.

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 lists products with pagination ('分页查询商品列表'), distinguishing it from siblings like pospal_get_product (single product) or pospal_create_product. The mention of HTML parsing adds context but doesn't overshadow the core 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?

No guidance on when to use this tool versus alternatives (e.g., pospal_get_product for a single product). There are no instructions on prerequisites, filtering, or when not to use it.

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