jumpserver_baseline_compare

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

With readOnlyHint=true already declaring a safe read, the description adds meaningful behavioral context: unreachable hosts are reported as unreachable, never as unchanged, which prevents a false 'no drift' reading. It also implies a fresh probe of live servers rather than a stored diff.

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?

Three sentences, each earning its place: the first defines the operation and its output fields, the second gives timing guidance, the third discloses the unreachable-host behavior. Front-loaded with the core purpose.

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?

With no output schema, the description compensates by enumerating the drift dimensions reported (ports, disk, services, roles, kernel, cores, memory, load) and the unreachable case. It is nearly complete, though output shape/format differences between text and json are left to the schema enum.

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 all four parameters are already documented, including the enum values for format and profile. The description adds no syntax or format detail beyond the schema, so the baseline of 3 applies.

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+resource pair (compare a saved baseline against current state) and names the exact sibling that produces the baseline, jumpserver_baseline_capture. It also distinguishes itself from the generic jumpserver_compare by specifying drift reporting on the same servers.

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?

Gives clear usage context: 'after a change window, or periodically, to prove what moved.' It implies the baseline must already exist but does not explicitly state prerequisites or when to prefer this over the sibling jumpserver_compare.

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