site_logs

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

Annotations already declare readOnly, idempotent, not destructive. Description adds critical behavioral details: FastPanel quirk (returns 'errors' field and 400 on success), normalization to 'log' field, empty log as '\n', missing file message. No contradictions.

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?

Description is slightly long but every sentence adds necessary context. Purpose is front-loaded. Could be a bit more concise, but well-structured overall.

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 behavior, edge cases (empty log, missing file), normalization, and result format ('log' field). No output schema but sufficient explanation. Annotations provide safety profile.

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?

All parameters have schema descriptions. Description enriches 'type' with real-world meaning (nginx vs Apache, error vs access) and explains log file paths. Adds value beyond schema.

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 it tails a site's nginx/apache access or error log without SSH. Specifies the endpoint and normalizes quirks. Distinguishes from sibling tools (none are log-specific).

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 guidance on when to use each type (frontend_error for 404/permission problems, backend_error for PHP-FPM errors). Does not explicitly mention when not to use this tool or alternatives, but usage context is clear.

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