flexsim_read_console

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

With no annotations, the description carries the full burden and does disclose meaningful behavior: the four distinct console backends and what each contains, plus the important gotcha that clear is unsupported and must be done via flexsim_execute_script. It stops short of stating whether reading is non-destructive, whether it works mid-run, or any permission/state requirements.

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?

Front-loaded with the core statement, followed by a compact Args block where each entry earns its place. The trailing clear note is slightly verbose but conveys a genuinely useful workaround, so little is wasted.

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, so return format need not be described, and the single nested params object is fully explained. For a one-parameter read tool this is nearly complete; only run-time/permission behavior is unaddressed, which is a minor omission given the low-risk read semantics.

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 0% and the inner $defs properties carry no descriptions, so the Args block does real work: it maps console values (compiler/system/output/script) to their meaning, notes 'script' is the editor text, and gives defaults for both parameters. It loses a point for documenting a `clear` argument that does not exist in the schema, which could mislead an agent.

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 FlexSim's consoles) and enumerates exactly what the agent gets back: compile errors, runtime exceptions, and prints. No sibling tool in the list reads console output, so it is unambiguous which tool to reach for.

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 a concrete routing rule for one case: clearing is not supported here, use flexsim_execute_script(`clearconsole();`) for the output console. It does not, however, frame when reading a console is preferable to flexsim_diagnose or flexsim_get_statistics for diagnostics, so the general 'when' is left implicit.

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