chat.cancel_knowledge_index

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

The description notes that the operation is a 'request' and that the job is 'async', giving some behavioral context. However, it does not disclose the return value, failure modes, idempotency, or permissions needed. With no annotations, the description carries the full burden and should offer more transparency.

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, well-structured sentence that front-loads the action and includes no redundant words. It is appropriately sized for the tool's simplicity.

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 one-parameter tool with no output schema, the description is adequate but lacks guidance on what to do after canceling (e.g., checking status) or what the expected response is. It does not explain edge cases, which would improve completeness.

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 input schema already describes jobId as 'Knowledge indexing job ID' with 100% coverage. The description adds no extra parameter semantics, so the baseline score of 3 applies.

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 (request cancellation) and the target (async repository knowledge indexing job). It distinguishes this from sibling tools like start_knowledge_index and get_knowledge_index_status by naming the specific 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 implies the tool is used when you want to cancel an indexing job, but it provides no explicit when-to-use or when-not-to-use guidance, nor any preconditions or alternatives. Context from sibling names helps but is not stated.

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