indexing-suspend-search-index

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

With no annotations provided, the description carries full burden. It states the action is 'suspend' (implying a temporary pause rather than permanent deletion), but doesn't disclose critical behavioral traits: whether this requires admin permissions, if suspended indexes can be resumed, what happens to in-progress operations, or any side effects. For a mutation tool with zero annotation coverage, this is inadequate.

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 with zero waste. The first states the core purpose, the second clarifies the parameter's default behavior. Every word earns its place, and the most important information is front-loaded.

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?

For a mutation tool with no annotations and no output schema, the description is minimally complete. It covers the basic action and parameter behavior, but lacks crucial context about permissions, reversibility, side effects, and what constitutes a 'running' index. Given the complexity of index management, more behavioral disclosure would be helpful.

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 schema already fully documents the single parameter. The description repeats the parameter's behavior ('If no name is provided, all running indexes will be suspended') but adds no additional meaning beyond what's in the schema. Baseline 3 is appropriate when schema does the heavy lifting.

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 specific action ('Suspend') and resource ('Sitecore search indexes'), with precise scope ('one or more'). It distinguishes from siblings like 'indexing-stop-search-index' by specifying suspension rather than stopping, and from 'indexing-resume-search-index' as its opposite operation.

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 description provides clear context for usage: 'If no name is provided, all running indexes will be suspended.' This gives explicit guidance on the default behavior. However, it doesn't mention when to use this versus alternatives like 'indexing-stop-search-index' or prerequisites for suspension.

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