Search Talonic Workspace

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

Annotations already provide readOnlyHint and openWorldHint. The description adds valuable behavioral context: 'Returns ranked results across all entity types in one call', result structure details (documents, fieldMatches, sources, etc.), and the note that 'fieldMatches[] include a filterable boolean' and the implication for talonic_filter usage. No contradictions with annotations.

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 well-structured with clear sections (STATUS, purpose, USE WHEN, DO NOT USE WHEN, TIP). It is front-loaded with the purpose. Every sentence adds value, and the length is appropriate for a search tool with multiple alternatives.

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 that the tool has an output schema (context signal true), only 2 parameters, and clear annotations, the description covers all critical aspects: when to use, when not, result structure, and a practical TIP. No gaps in decision-making or behavior understanding.

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 3. The description does not add new meaning to the 'query' or 'limit' parameters beyond the schema descriptions. The TIP about filterable is about the result, not the parameters. Thus, no extra parameter information is provided.

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 'Search the user's Talonic workspace for documents, fields, sources, or schemas matching a query.' It uses a specific verb 'Search' and resource 'workspace', and lists entity types. The use of 'returns ranked results across all entity types in one call' further clarifies scope. It distinguishes from sibling tools like talonic_get_document and talonic_filter via usage guidelines.

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 includes explicit 'USE WHEN' and 'DO NOT USE WHEN' sections with concrete conditions (e.g., conceptual queries, unknown filename) and directly names alternative tools (talonic_get_document, talonic_filter, talonic_extract). This provides the agent with clear decision criteria.

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