list-auditlogs

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

Discloses key behaviors: default date range, maximum range, optional filters. No annotations provided, so description carries burden. Missing details on pagination, auth, or rate limits, but acceptable for a list endpoint.

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?

Three efficient sentences: purpose, default behavior, constraint. No wasted words, front-loaded with key information.

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?

Covers constraints and defaults. No output schema, but description doesn't explain return structure or pagination. Sibling tools may inform, but slight gap for full 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 has 100% coverage so baseline is 3. Description adds value by explaining default and max date range beyond schema descriptions, especially for fromUtcDateTime and toUtcDateTime.

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?

Clearly states the tool returns a list of audit log items for a given product, with optional filters by config and environment. Differentiates from sibling list-organization-auditlogs by focusing on product-level logs.

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?

Provides clear default behavior (last 7 days) and constraint (max 30 days). Lacks explicit guidance on when to choose this over alternatives like list-organization-auditlogs, but the context is implied.

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