vremly_search_endpoints

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

The description implies a read-only search operation without stating it explicitly. Since no annotations are provided, the description carries the full burden of disclosing side effects. While the nature of a search tool makes mutations unlikely, explicitly noting that it does not modify any resources would improve transparency.

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 concise and well-structured. It opens with the primary action and resource, then provides scope, use-case guidance, and output details in a logical flow. Every sentence serves a purpose, with no fluff or unnecessary repetition.

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?

The description is complete for a search tool. It explains what the tool does, when to use it, what it returns, and how to get more detail via the sibling describe_endpoint. It does not need to explain output schema since it explicitly mentions the returned fields. This covers all essential context an agent needs.

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 covers all three parameters (query, limit, method) with 100% description coverage. The description adds valuable nuances: the 'query' parameter's requirement that all terms must match, and the 'method' parameter being an optional filter. This enhances the schema without redundancy.

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 purpose: searching the Vremly API by keyword. It specifies the scope (1037 operations covering various domains) and the primary use case (when the exact path is unknown). This unambiguously distinguishes it from the sibling describe_endpoint and request tools.

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 explicitly instructs to 'start here' when the path is unknown, and it outlines what the tool returns (method, path, summary, tags) and how to proceed for full details (pass result to describe_endpoint). This gives clear guidance on when and how to use it, including a natural handoff to the next tool.

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