list-organization-auditlogs

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

Discloses default date range and maximum window, which goes beyond the schema. However, lacks information on pagination, sorting, or potential rate limits, which would be helpful for a read operation.

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 sentences, front-loaded with the main purpose, then adding filtering details and constraints. Every sentence adds 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?

Covers filtering and date constraints adequately for a read tool, but lacking details on pagination, sorting, or response structure, which are important for an API with 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?

Schema coverage is 100%, and the description adds meaningful context for date parameters (default and max distance) and mentions optional filtering by Product, Config, Environment, but does not elaborate on each parameter beyond what the schema provides.

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 it returns the list of Audit log items for a given Organization and mentions optional filtering, distinguishing it from other list tools.

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 context: default behavior (last 7 days) and constraint (max 30-day window), but does not explicitly exclude alternatives or explain when to use this over similar tools like list-auditlogs.

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