flexsim_get_statistics

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

With no annotations, the description carries the full burden; it does disclose useful traits such as the JSON return type, the two backend modes (window vs Python), and the default inclusion of Model.time. It does not state permission/auth requirements, whether the call has side effects beyond reading, or any cost/rate considerations, leaving notable behavioral gaps.

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 purpose, then a structured Args block. Sentences are tight and every line adds information; sizing is appropriate for a tool with a nontrivial metrics grammar.

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 details are not required, and the description covers the key parameter semantics and the metrics grammar. It is broadly complete for calling the tool correctly, though it omits the objects cap and says nothing about how multiple backends affect results.

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 0%, so the description must compensate, and it does: objects defaults to all model objects, include_time defaults to True and adds Model.time, and metrics is documented via a grammar (<group>.<field>) plus concrete examples. Only minor gaps remain (e.g., the 50-item cap on objects is not mentioned).

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: 'Read TrackedVariable statistics as JSON'. It also clarifies the retrieval mechanism ('window or Python backend') and that it supersedes manual `k.stats.input.value` reads, which makes the function recognizable. It does not explicitly contrast itself with nearby siblings like flexsim_get_performance_measure or flexsim_get_node_value, so it falls short of a 5.

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?

'Replaces hand-written k.stats.input.value reads' implies the intended use case (fetching tracked-variable metrics instead of scripting them). However, there is no explicit guidance on when to prefer this over flexsim_get_performance_measure, flexsim_get_time, or direct node reads, so usage is only implied.

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