atlas_search_upsert_analyzer

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

No annotations are provided, so the description must fully disclose behavioral traits. It only states 'Create or update' without detailing what happens on update, whether it replaces or merges, required permissions, rate limits, or side effects. The description is insufficient for an agent to understand the tool's behavior.

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 concise sentence with no waste. However, it is too brief to be fully informative and could benefit from additional structured detail without losing 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 of an upsert operation with a nested parameter (body) and no output schema, the description is incomplete. It fails to explain the expected format of body, the effect of options, or return values, leaving significant gaps for an agent.

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 67% (clusterName lacks description, body is 'Analyzer definition(s)', options is 'Optional parameters'). The description adds no extra meaning beyond the schema. The nested body parameter lacks details about its structure, and options remains vague.

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 action (create or update), the resource (Atlas Search analyzers), and the scope (for a cluster). It effectively distinguishes from sibling tools like atlas_search_create (which creates a search index) and atlas_search_get_all_analyzers (which lists analyzers).

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 is provided on when to use this tool vs alternatives (e.g., atlas_search_create, atlas_search_update), nor any prerequisites or conditions. Missing context on behavior when an analyzer already exists or when to prefer upsert over separate create/update.

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