discord_set_onboarding

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

Goes well beyond the annotations by disclosing the required guild feature and permission, the hard validation constraints (seven default channels, one prompt with at least one option in advanced mode), and the replace-wholesale semantics of the prompts array — a side effect the agent could not infer from destructiveHint=false alone.

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-loaded with the core action, then prerequisites, then the LIMITATION marker, then side effects. Four sentences all carry information; the final sentence about the return value is redundant given the output schema exists.

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 mutation tool with an output schema, the description covers permissions, feature gating, validation limits, and replacement semantics — everything needed to call it without a surprise failure. The one gap is not directing the agent to read the existing configuration before overwriting it.

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 100%, so the baseline is 3. The description adds the advanced-mode validation rule that ties default_channel_ids and prompts together, but most parameter meaning (mode enum, reason, enabled, nested prompt fields) is already fully documented in the 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?

Opens with a specific verb+resource ("Configure the server's onboarding flow") and enumerates the three things it controls: enablement, default channels, and prompts with options. It is clearly distinct from the read-only sibling discord_get_onboarding, though it never names that sibling explicitly.

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?

States the prerequisites (COMMUNITY feature, Manage Server) and the validation rules Discord enforces, which tells an agent when the call will fail. It does not advise reading the current state via discord_get_onboarding first, nor does it say when to prefer 'default' over 'advanced' mode beyond the schema's own wording.

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