add_field_migration

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

No annotations are provided, so the description carries full burden. It states 'create a migration file' but does not disclose what that entails—e.g., where the file is created, whether it is applied immediately, or any side effects. The behavioral impact is minimally transparent.

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?

One short sentence, no wasted words. However, it could benefit from slightly more detail (e.g., type of file generated) without becoming verbose. Still good conciseness.

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 complexity (3 parameters, nested object, no output schema, many sibling tools), the description is incomplete. It does not explain the return value, the exact nature of the migration file, or how it relates to the migration workflow. An AI agent would lack full context to use the tool correctly.

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 baseline is 3. The description adds no additional parameter information beyond what the schema already provides (e.g., 'collectionNameOrId' as name/ID, 'fieldDefinition' with required name/type). No extra semantic value.

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 uses a specific verb (Create) and resource (migration file for adding a field to an existing collection). It clearly distinguishes from sibling tools like create_migration (generic) and create_collection_migration (likely creates collection), making the tool's purpose unambiguous.

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?

No guidance on when to use this tool versus siblings such as create_migration or create_collection_migration. No prerequisites (e.g., collection must exist) or when-not-to-use conditions are mentioned.

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