search

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

With no annotations, the description must carry behavioral disclosure. It does state that search covers names and docstring summaries, lists kind categories, and says versions default to latest, but it omits matching behavior such as exact versus partial matching, case sensitivity, result ordering, and limits.

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 front-loaded with the tool's purpose and then covers relevant parameter semantics compactly. The inline enumeration of kind values is slightly cramped but every sentence earns its place.

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 gives enough information to invoke the tool with a query, kind, and optional versions, and the output schema covers return values. However, it lacks sibling routing guidance and does not fully disclose search matching behavior, which matters for correct selection and use.

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 0%, so the description must compensate. It usefully defines the kind enum values that are not in the schema and explains pylops_version and pyproximal_version with examples and default behavior, though the query parameter is only implicitly documented as the search term.

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 states a specific verb and resource: search PyLops and PyProximal by name or docstring summary. It is clearly a search tool, but it does not explicitly distinguish itself from sibling list_* or get_* 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?

Usage is implied by the word 'search' and the kind filters, but the description gives no explicit guidance on when to use this tool versus list_operators, list_solvers, get_operator, or other siblings. There are no when-not-to-use conditions either.

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