get_environment_logs

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

The description notes that logs are read via SSH, implying network and authentication requirements. With no annotations provided, the description carries the full burden of behavioral disclosure but omits details like error handling, rate limits, or whether the operation is truly read-only. The description adds the SSH context but lacks depth.

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 two sentences with no redundancy or filler. Every sentence serves a purpose: the first defines the primary action, and the second directs to a sibling tool. It is front-loaded with the core function.

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 description is concise but lacks completeness for a tool with 4 parameters and no output schema. It does not explain the return format (e.g., log lines as a string or array), error conditions, or behavior when optional parameters are omitted. The reference to list_log_types helps but is insufficient for full autonomous usage.

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?

The schema covers 100% of parameters with descriptions, so the baseline is 3. The description does not add any additional information about parameters beyond what the schema provides. The enum for 'type' and defaults for 'lines' are already documented in the 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?

The description clearly states the tool reads logs from a Magento Cloud environment via SSH, using a specific verb ('Read') and resource ('logs'). It distinguishes itself from sibling tools like list_log_types, which lists available log types, and other tools that manage environments or execute SQL.

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 explicitly directs the agent to use list_log_types to see available log types, providing clear context for tool selection. However, it does not specify when not to use this tool (e.g., if logs are not accessible via SSH) or mention alternatives beyond list_log_types.

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