indexing-stop-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 discloses the tool's behavior regarding parameter handling (optional name parameter with default behavior) but doesn't mention important aspects like whether stopping is reversible, if it requires admin permissions, what happens to in-progress operations, or any rate limits.

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 explains parameter behavior. Perfectly front-loaded with essential information first.

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 destructive operation tool with no annotations and no output schema, the description is adequate but incomplete. It covers the basic functionality and parameter behavior but lacks critical information about side effects, permissions required, reversibility, and expected response format.

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?

The description adds meaningful context about the parameter's effect ('If no name is provided, all running indexes will be stopped'), which complements the schema's 100% coverage. This clarifies the default behavior when the parameter is omitted, going beyond the schema's basic description.

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 ('Stop') and resource ('Sitecore search indexes'), with precise scope ('one or more'). It distinguishes from sibling tools like 'indexing-suspend-search-index' by specifying a stop action rather than suspension.

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 when to use it (stopping indexes) and includes a conditional rule (if no name provided, stops all running indexes). However, it doesn't explicitly mention when NOT to use it or name alternatives like 'indexing-suspend-search-index' for temporary pauses.

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