create_promotion

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

No annotations; description discloses side effects: adds promotion, immediate activation possible, mentions update alternative. Lacks permission or reversibility info but 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?

Well-organized with sections: WRITE mark, purpose, API, return structure, side effects. Every sentence adds value, no 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?

Provides return structure and side effects. Single-parameter tool, so low complexity. Description is complete 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?

Only one parameter (promotion_data) with schema description in Chinese. Description adds context that it follows Shopline's object structure, aiding understanding beyond schema.

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?

Explicitly states 'create new promotion activity' with examples (discount codes, BOGO). Distinguishes from update_promotion in side effects.

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?

Mentions API endpoint and side effects. Implicitly says use when needing a new promotion, and to modify use update_promotion. Could be more explicit about when not to use.

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