foundry_search

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

The readOnlyHint annotation already communicates that this is a safe read operation, so the description does not need to repeat that. It does add the scope of searching 'world entities and compendiums,' which is beyond the annotation, but it offers no additional behavioral details like result limits, pagination, or permission requirements.

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, concise sentence with no wasted words. It is appropriately brief for a simple search tool, though it could have been slightly more detailed without becoming verbose.

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?

Given the tool has 8 parameters, no output schema, and no usage context, the description is inadequate. It does not explain what results look like, how to paginate or limit results, or how search differs from direct entity retrieval, leaving significant gaps for an agent to infer.

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 only 25%, and the tool description does not compensate for the six undocumented parameters. It only implies that a 'query' or 'filter' parameter is involved, but it does not explain their syntax, purpose, or how they interact, leaving most parameters semantically under-specified.

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 verb 'search' and the resource 'world entities and compendiums,' which distinguishes it from sibling tools like get_entity or get_structure. However, it lacks specificity about what constitutes 'world entities' and whether it also searches folders or other resources, leaving some ambiguity.

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 provides no guidance on when to use this tool versus alternatives such as get_entity, get_structure, or list_files. It does not mention any exclusions, prerequisites, or typical use cases, so the agent is left without context for selecting this tool over others.

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