search_entities_with_query

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, but it falls short. It mentions pagination (from, size) and sorting (sort_field, sort_order) parameters that are not present in the schema, which is misleading. It also fails to mention that the tool is read-only or describe the return format.

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 short, but the second sentence about pagination and sorting wastes space on parameters that are not available. It does not earn its place, making the description less concise than it appears.

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 a single-parameter schema, no output schema, and no annotations, the description is incomplete. It fails to explain the query syntax for 'q' or the nature of the search results, and the misleading parameter references further detract from 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?

The schema coverage is 0%, yet the description does not explain the sole parameter 'q' at all. Instead, it introduces parameters (from, size, sort_field, sort_order) that do not exist in the input schema, actively confusing the agent about the available options.

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 that the tool searches entities, using the verb 'Search' and resource 'entities', which distinguishes it from the table-specific sibling tools. However, the phrase 'using query test' is awkward and likely a typo for 'query text', which slightly obscures the intended functionality.

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?

No guidance is given on when to use this tool versus alternatives. The description only mentions pagination and sorting instructions without explaining when this search tool is appropriate compared to table-specific tools like get_table_by_fqn or get_list_of_tables.

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