cigchat_set_integration_shopify

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

With no annotations provided, the description takes on the full burden. It discloses the required 'Manage Team' scope and the date-specific protocol for api_key/token fields. It does not detail side effects, reversibility, or return values, but it does add meaningful behavioral context beyond just saying 'update'.

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 two sentences, front-loaded with the primary action, and every sentence adds value. It efficiently combines purpose, conditional guidance, and a prerequisite.

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 description, combined with the 100% schema coverage, sufficiently explains the tool's purpose and input requirements. It lacks return value or error handling information, but for a config update tool, the provided context is reasonably complete given the sibling tools and schema.

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 coverage is 100%, so baseline is 3. The description adds specific semantic guidance for api_key and token, clarifying exactly which values to use for new custom apps after 2026-02-01, which is more precise than the schema's general descriptions.

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 'Update the config of shopify integration' with a specific verb and resource. It distinguishes itself from sibling tools like get_integration_shopify (read) and clear_integration_shopify (delete), and from other set_integration_* tools by naming the platform.

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 conditional usage guidance: for new custom app integrations after 2026-02-01, specific field mappings are given. It also mentions a required scope. However, it does not explicitly state alternatives or when not to use this tool, so it falls short of a 5.

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