tracecat_create_variable

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

No annotations are provided, so the description must disclose behavioral traits. It only states 'Create a non-sensitive variable' without mentioning idempotency, error behavior, authorization needs, or side effects. As a create tool, more transparency on what happens on duplicate or success/failure conditions is needed.

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 two sentences with no fluff: the first sentence states the purpose with illustrative examples, the second provides the key alternative for secrets. It is front-loaded and each sentence adds direct value.

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 and 4 parameters, the description covers the primary purpose and differentiates from secrets but omits details like the optional 'environment' default, return value, and potential error states. It is adequate but not thorough for a complete understanding.

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 input schema covers all 4 parameters with descriptions (100% coverage), so the baseline is 3. The description adds minor context (e.g., 'non-sensitive') but does not enhance parameter understanding beyond the schema. Given high schema coverage, a 3 is appropriate.

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 creates a non-sensitive variable and provides examples (base URLs, project IDs, tenant defaults). It explicitly distinguishes the tool from the sibling tracecat_create_secret for secrets, making the purpose unmistakable.

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 tells when to use this tool (non-sensitive variables) and when not to (secrets) with a specific alternative. It lacks broader usage context like whether the variable can be overwritten or conditions for use, but the guidance is clear and actionable.

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