tracecat_list_variables

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

Discloses that only non-sensitive variables are listed, which is critical behavior. No annotations are provided, so description carries full burden. However, it doesn't mention pagination, limits, or ordering.

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 concise sentences: first states purpose, second provides usage guidance. No wasted words, front-loaded with primary action.

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?

For a simple list tool with one parameter, it covers purpose and usage. Lacks output format details (e.g., list of objects with name, environment) but is largely complete given no output schema.

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?

Only one parameter, 'environment', with schema coverage 100%. Description adds 'Filter by environment (default: all environments)' which is similar to schema description. Adds minimal new meaning.

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 lists non-sensitive workspace variables and includes the specific fields returned (names + environments). It distinguishes from secrets tools and siblings like tracecat_get_variable.

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 says 'For secret values use secrets tools instead', providing a clear when-not-to-use. It implies usage for listing variables, though lacks exhaustive alternative references.

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