edgegate_register_byo_bucket

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

With no annotations, the description fully discloses behavior: Enterprise-only restriction, required owner role, security model ('AssumeRole... never leave your account'), return value (External ID), and specific error codes. This far exceeds the bare minimum and provides critical operational context.

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 dense but not bloated. It front-loads the most critical information (Enterprise only, use alternative for new setups), then covers function, security, return, permissions, and errors in a compact, logical flow. Every sentence earns its place.

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?

Given the tool's complexity (BYO storage, IAM roles, External ID), the description is remarkably complete. It explains the purpose, usage, prerequisites, return value, error conditions, and security implications. No output schema exists, but the description explicitly mentions the return value, making the tool self-contained.

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 80% (4 of 5 parameters have descriptions), so the baseline is 3. The description does not add parameter-specific details beyond what the schema already provides, but it doesn't need to since the schema is rich and descriptive.

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 tool's function: 'Registers the workspace's customer-owned S3 bucket + IAM role as a BYO storage grant.' It also distinguishes itself from the main sibling, edgegate_setup_byo_storage, by explicitly noting this tool is for existing IAM roles only and directs users to use the alternative for new setups.

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?

Provides explicit when-to-use versus alternatives: 'Use edgegate_setup_byo_storage instead for new setups — this tool only works if you already have an IAM role and just want to register its ARN.' Also notes prerequisites (owner role) and error conditions (402 for non-Enterprise, 409 if grant exists), giving clear context for invocation.

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