astrovisor_openapi_search

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

No annotations are provided, so the description carries full burden. It states it returns top matches but does not disclose pagination, sorting, or behavior for no results. It is adequate but minimal beyond what the schema provides.

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 that is front-loaded with the key action and scope. No extraneous information.

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 no output schema, the description could better indicate the return structure (e.g., list of operations). For a search tool, it is functional but leaves the agent inferring the response format. Adequate but with room for more 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 already provides 100% description coverage for parameters. The description adds value by specifying the searchable fields (operationId, summary, path, tag) and clarifying that results are top matches, enhancing understanding beyond the 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 AstroVisor OpenAPI operations by text across multiple fields (operationId, summary, path, tag) and returns top matches. It distinguishes from sibling tools like astrovisor_openapi_list (list all) and astrovisor_openapi_get (get specific) by focusing on search.

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 implies usage for searching operations by text, but does not explicitly state when to use versus alternatives or provide when-not guidance. It is adequate for basic understanding but lacks explicit context.

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