zpa_get_lss_log_format

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

Annotations already provide readOnlyHint: true, so the description's 'read-only' is redundant but consistent. The description adds context about the templates being pre-built and available formats, which is useful but does not disclose behavior on invalid log types or rate limits. Given annotations, a 3 is appropriate.

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, front-loaded sentence that efficiently conveys purpose, resource, scope, and format options. Every word adds value, and there is no wasted text.

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?

The tool has low complexity (1 param, output schema exists). The description covers the core purpose but misses guidance on valid log_type values or referencing sibling tools for discovery. With output schema, return values are handled, but completeness is slightly lacking.

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?

With 0% schema description coverage, the description only vaguely states 'for a log type' without explaining valid values, where to find them, or format expectations. It does not point to sibling tools like zpa_list_lss_log_types. For a single required parameter, this is insufficient guidance.

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 verb 'Get', the resource 'pre-built LSS log-format templates', and the scope 'for a log type', including specific formats (csv/json/tsv) and a read-only hint. It effectively distinguishes from sibling tools like zpa_list_lss_log_types which list log types rather than templates.

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 implies usage by stating 'for a log type' and 'read-only', but lacks explicit guidance on when to use this tool vs alternatives (e.g., zpa_list_lss_log_types to find valid log types) or when not to use it. No exclusions or prerequisites are mentioned.

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