entity_search

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

No annotations provided, so description carries burden. It declares read-only and returns entity records, but lacks details on ordering, pagination, or exact structure of returned records. Adequate but not rich.

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 concise sentences. First sentence states purpose, second gives usage guidelines and alternatives. No superfluous information. Front-loaded with key action.

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?

With 5 parameters (all optional) and no output schema, description covers when to use and what it does. Lacks details on result ordering, pagination, or exact content of entity records, but sufficient for basic search tool.

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%, so baseline is 3. Description adds context that 'query' is substring matched against key, canonical name, aliases, but this is already implicit in schema. No significant added value beyond schema.

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 searches the entity graph by key, canonical name, alias, or type with substring match. It explicitly distinguishes from sibling tools like 'search' (for memories), 'graph_neighbors', and 'graph_context'.

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?

Provides explicit guidance on when to use this tool: to resolve an entity_key or canonical name from partial term. Also states when to use alternatives: 'search' for memory content, 'graph_neighbors' or 'graph_context' for graph traversal.

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