create_custom_hostname

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

Description adds critical behavioral details beyond annotations: the confirm gate and preview behavior. It clarifies that this is a mutation requiring human approval, which annotations (readOnlyHint=false, destructiveHint=false) alone do not capture.

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?

Two sentences, zero wasted words. Front-loads purpose and key constraint.

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?

No output schema, so description should hint at return values or results. It only mentions 'preview' but not success response. Also missing prerequisites (e.g., zone must have SSL for SaaS enabled). Incomplete for a 5-param tool.

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. Description reinforces the confirm parameter's role but does not add significant new semantic meaning beyond 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?

Description clearly states 'Add a custom hostname (SSL for SaaS) to a zone', specifying verb and resource. The phrase 'SSL for SaaS' distinguishes it from siblings like create_dns_record.

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?

Description provides clear context about the confirm gate and preview behavior, but does not explicitly contrast with siblings or state when to use this tool over alternatives.

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