index_soul_workspace

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

With no annotations, the description carries full burden. It discloses incremental indexing via SHA-256, first-call download of ~80MB model, and creation of .rag_index/ directory. This provides solid behavioral context, though it could mention idempotency or error conditions.

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?

Three sentences front-loaded with purpose, then incremental behavior, then first-time notes. No wasted words; each sentence adds distinct value.

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?

Covers key aspects: indexing scope, incremental update, download size, output directory. Lacks details on invalid paths or file types, but overall sufficient for a tool with an output schema.

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 coverage is 100% with a clear parameter description. The tool description reinforces that the parameter is the workspace path but adds no new semantics beyond 'Index all markdown/text files in the soul workspace.' Baseline 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 tool indexes all markdown/text files into a local vector DB, with specific verb 'Index' and resource 'markdown/text files in the soul workspace'. It distinguishes from siblings like get_rag_context (retrieval) and memory_save (saving).

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 usage for initial indexing or updating via incremental hashing, but does not explicitly state when to use this tool versus alternatives (e.g., when to index vs. retrieve). No when-not or alternative guidance is provided.

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