Retrieve recent output from a Shelly terminal session. Specify max lines or omit session ID to read the active session.
Read recent output from a Shelly terminal session. Omit sessionId for the active session.
| Name | Required | Description | Default |
|---|---|---|---|
| maxLines | No | Max lines to return (default 200) | |
| sessionId | No | Terminal session id (optional — defaults to the active one) |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. "Read" plus "recent output" conveys a bounded, non-mutating read and the active-session default, but it says nothing about whether the buffer is consumed/cleared, how truncation is signaled, or whether output is ordered or live.
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 short sentences, zero filler, with the core purpose front-loaded before the parameter hint. Nothing to cut.
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?
A two-parameter, all-optional read tool with a fully-described schema and no output schema. The description covers purpose and default behavior adequately, though for an unannotated tool a sentence on buffer/consumption semantics would close the remaining gap.
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%, so both parameters are already documented in the input schema; baseline 3 applies. The description's note about omitting sessionId duplicates the schema's own "defaults to the active one" note and adds no format or edge-case detail.
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?
States a specific verb and resource: "Read recent output from a Shelly terminal session." Clear enough to distinguish the read path from run_command/write_file, but it never names those siblings or explicitly contrasts reading output with executing a command.
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 only guidance is scoping advice ("Omit sessionId for the active session"), which is really parameter behavior. There is no statement of when to call this versus run_command, or whether output must be read after a run before it's lost.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.