suggest_env_vars

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

No annotations are provided, so the description must disclose behavior fully. It states the return type (keys and IDs) but does not mention pagination behavior, matching algorithm (exact vs partial), or order of results. With pagination parameters in the schema, some behavioral context is missing.

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?

Two sentences, no fluff. First sentence states the verb and resource. Second sentence provides usage guidance. Every word 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 covers the tool's purpose and usage context well. For a simple search tool with pagination (3 params, no output schema), it provides adequate information. However, it could mention pagination behavior (e.g., default page size) or error handling for 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?

Schema description coverage is 100%, so the baseline is 3. The main description adds no additional semantics beyond the schema; it only mentions 'by name' corresponding to the query parameter. No new meaning is provided for 'page' or 'size'.

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 uses a clear verb 'Search' and specifies the resource 'environment variable definitions by name'. It distinguishes itself from siblings like 'list_env_vars' (list all) and 'suggest_env_var_values' (suggest values) by focusing on name-based search and returning IDs.

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?

Explicitly states the primary use case: 'Use this to find the exact name of an env var key before querying values.' This provides clear guidance on when to invoke this tool and implies it is a preparatory step, distinguishing it from value querying tools.

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