appcrane_get_logs

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

No annotations provided, but the description explains the tool returns the most recent N lines (default 100, max 1000), supports case-insensitive substring filtering via search, and notes error case ('no such container' errors occur pre-container). It implies read-only behavior but could be more explicit about idempotency.

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?

Two concise paragraphs. First paragraph states purpose and key parameter details. Second paragraph clarifies exclusion with a concrete example. No filler, front-loaded with essential 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?

Given 4 parameters, no output schema, and no annotations, the description covers all critical aspects: function, parameters (with defaults and limits), filtering, stage, and importantly when not to use with a sibling reference. Agent can correctly invoke it.

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 50%. Description adds meaning for 'lines' (default, max) and 'search' (case-insensitive substring filter), and mentions 'stage' implicitly. However, the required 'slug' parameter is not explained, relying on context from the tool name. Overall partial compensation for missing schema descriptions.

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 opens with 'Get recent runtime logs from a running app container (docker logs)', using a specific verb and resource. It distinguishes itself from sibling tool appcrane_get_deploy_log by clarifying this is for runtime issues, not deploy failures.

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?

Explicitly states 'NOT the right tool for fast deploy failures... Use appcrane_get_deploy_log for that.' Provides clear when-to-use (runtime issues), when-not-to-use (deploy failures), and a named alternative.

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