Get Console Log for a Device

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

The readOnlyHint annotation already establishes the safety profile. The description adds useful behavioral context by explaining that this returns the console/terminal buffer, including boot and syslog messages, rather than executing new commands. It still does not discuss truncation behavior or buffer limits in the description, though max_chars is documented in the schema.

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 definition is front-loaded with the core purpose, followed by concise, relevant examples. Every sentence contributes to understanding what the tool returns and when to use it.

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?

An output schema exists, annotations cover the read-only nature, and parameter descriptions are complete in the schema. The description supplies enough context about the console buffer contents and usage examples for an agent to invoke it correctly.

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 description coverage is 100%, so both parameters are already documented. The description's examples illustrate device names like R1, PC1, and switch, but add little beyond the schema for the name and max_chars parameters.

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 uses a specific verb and resource: return the device's console/terminal buffer as shown in the CLI tab or Command Prompt. It identifies the exact content returned (boot messages, syslog, recent command output), which distinguishes it from generic command execution or command-history tools.

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 examples clearly indicate when to use the tool, such as inspecting console messages, checking whether an interface went down, or reviewing PC command prompt output. It does not explicitly name alternatives or when not to use it, but the 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.