tracecat_search_secrets

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

With no annotations, the description must fully disclose behavior. It only says 'Search' without detailing result format, pagination, or that it returns multiple items. The lack of behavioral traits beyond search scope is insufficient.

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 sentence, but it is inaccurate and omits key info. It fails to earn its place as it introduces confusion rather than clarity.

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?

Given no output schema and two optional parameters, the description should clarify search behavior, default environment, and return format. It only mentions name/type, which is incomplete and incorrect.

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 coverage is 100% with descriptions for both parameters, but the description mentions 'type' which is not in the schema, and omits 'environment'. This misleads the agent about available filters, adding negative value.

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 'Search for secrets by name or type', but the input schema includes 'name' and 'environment' parameters, not 'type'. This mismatch reduces clarity. However, the verb 'Search' indicates a read operation, which distinguishes it from creation/deletion siblings.

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?

No guidance is provided on when to use this tool versus alternatives like tracecat_get_secret or tracecat_list_secrets. The description does not mention exclusions or context, leaving the agent to infer use cases.

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