set_customer_metafield

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

No annotations are provided, so the description carries full burden. It states the tool uses metafieldsSet and performs an upsert, implying it can overwrite existing metafields. However, it does not disclose potential side effects, authorization needs, or behavior when the metafield exists vs. doesn't exist.

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 a single sentence with no extraneous words, clearly front-loading the purpose. Highly efficient.

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?

For a 5-parameter upsert tool with no output schema or annotations, the description is brief. Lacks details on return values, namespaces, or error conditions. Adequate but not complete.

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 the parameters are well-documented in the input schema. The description adds minimal meaning beyond 'upsert' and does not elaborate on parameter roles (e.g., type required for creation). Baseline 3 appropriate.

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 verb ('create or update') and resource ('customer metafield'), and specifies the underlying API method (metafieldsSet, an upsert). This distinguishes it from sibling tools like get, delete, or list.

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 mentions it's an upsert (create or update) but provides no explicit guidance on when to use this tool vs. alternatives like create_metafield_definition or update tools. No prerequisites or context for selection given.

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