embed_repo

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

No annotations provided, but description discloses local CPU execution, no API keys, incremental updates, and pip requirement. Adds significant behavioral context beyond default read/write assumptions.

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?

Extremely concise: four short sentences covering purpose, prerequisite, model details, and behavior. Every sentence adds value without redundancy.

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 purpose, sequence, and model behavior well, but fails to document two of three parameters (exclude_dirs, output_format). Output schema exists, so return info not required, but parameter gap reduces 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?

Schema description coverage is 0%, so description must compensate. Only repo_path is mentioned (in a minimal way), while exclude_dirs and output_format are completely undocumented. Insufficient for parameter understanding.

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?

Clearly states it generates embeddings for semantic search across symbols. Explicitly ties to index_repo and hybrid search, distinguishing it from sibling tools like index_repo and search_semantic.

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?

Tells user to run after index_repo and mentions idempotent behavior (only missing vectors). Lacks explicit when-not or alternative tools, but context is clear.

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