ddb_generate_gsi

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

No annotations are present, so the description must carry the behavioral burden. 'Generate configurations' does not clarify whether this runs against an existing table, emits a config file, mutates infrastructure, or only produces a template, nor are auth requirements or side effects disclosed.

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, efficient sentence with the core action and purpose front-loaded. It contains no filler or redundant restatement of the tool name, though it is brief to the point of underspecification.

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?

With no annotations, no output schema, and only a one-line description, the agent lacks important operational context: what the generated configuration looks like, whether the table must already exist, how the api_key is required, and what happens if projections conflict. This is not enough for a 6-parameter 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 description coverage is 100%, so the input parameters and their meanings are fully documented in the schema itself. The description adds no extra semantic detail about parameters such as projection boundaries, partition key requirements, or how api_key is used 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?

The description names a specific verb ('Generate'), resource ('Global Secondary Index configurations'), and intent ('for alternate query patterns'). It is clear about what the tool produces, though it does not explicitly distinguish itself from siblings like ddb_design_table or ddb_optimize_queries.

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 phrase 'for alternate query patterns' gives an implied usage context, suggesting this tool is for generating GSI configs when alternate access patterns are needed. However, it does not mention alternatives or exclusion conditions, leaving the sibling distinction to inference.

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