semantic_index

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does not mention whether the operation is destructive, requires specific permissions, modifies existing indexes, or what the output looks like. The phrase 'Index a local text file or directory' hints at reading files and creating an index, but side effects are not disclosed.

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 sentence, front-loaded with the verb and resource, and contains no filler. Every word earns its place.

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?

The tool has no output schema and no annotations, so the description is the only source of information. It does not explain what the tool returns, whether it can be run repeatedly, or how the index integrates with semantic_search. While the tool has only one parameter, key operational details are missing.

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 schema describes 'path' only as a string, but the description adds that it should be a local text file or directory, which clarifies the expected input. This compensates for the 0% schema description coverage, though it could specify supported file types or recursion behavior.

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 tool's action ('Index') and resource ('local text file or directory'), and specifies its purpose ('for private semantic search on the Intel NPU'). It distinguishes from siblings like semantic_search, which searches, and semantic_index_status, which checks status.

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 that this tool should be used before semantic_search to build an index, but it does not explicitly state when to use it vs alternatives or mention any prerequisites or exclusions. It provides context but no direct guidance on choosing between tools.

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