upsert_helper

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

With no annotations, the description carries the full burden. It usefully discloses that the domain is reloaded automatically after the operation – a meaningful side effect. However, for a mutation tool it does not state whether an existing helper is overwritten (destructive) or how conflicts between create/update are resolved, nor any auth requirements.

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?

Front-loads the verb phrase and reload behavior, then organizes the parameters cleanly with examples. The examples are useful rather than filler, though the multi-line arg list with inline examples is slightly verbose.

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 covers the three params and one key side effect, which is decent for a 3-param, no-output tool. But with no annotations and no mention of overwrite/destructive behavior, error conditions, or how it interacts with existing helpers, an agent lacks enough to call it confidently in edge cases.

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%, so the description must compensate – and it does well: it enumerates the allowed domain values, explains helper_id as a slug with an example, and gives concrete YAML config examples per domain. It doesn't fully document the config object's full schema (additionalProperties: true), leaving some ambiguity, but adds substantial meaning beyond the bare 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?

States a specific verb+resource ('Create or update a helper') and even adds the reload side-effect. Sibling tools like delete_helper/list_helpers/get_helper are clearly distinct by verb, though the description doesn't name them. Clear and specific, but no explicit sibling differentiation.

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?

Implies upsert semantics via 'Create or update' (so the agent knows it handles both cases) and notes the domain reload. But there is no guidance on when to use this vs. delete_helper or list_helpers, no note that the helper must not already exist under a conflicting type, and no prerequisites. Usage context is only implied.

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