flexsim_connect_objects

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

With no annotations, the description carries the full burden and largely meets it: it discloses that connections ACCUMULATE (1-2-3...), that flexsim_disconnect_objects must precede reconnecting to avoid duplicate links, and what verify actually inspects (outObjects/inObjects vs centerObjects). It omits mutation/error/permission behavior, keeping it out of the top band.

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 purpose, then kind-specific usage, then a NOTE on accumulation, then Args — a sensible order with no filler. The contextdragconnection('A'/'S') internals are implementation trivia an agent does not need, a minor waste.

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 values need not be explained, and the description covers the mode switch, the accumulation hazard, and the verification option. The 'window backend only' constraint is surfaced. What is still absent is failure behavior (e.g. invalid source/target, duplicate rejection) and any permission requirement.

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 Args block does the work: source is 'origin (or requester for resource)', target is 'destination (or resource for resource)', kind is flow/resource, verify toggles structural verification. Crucially it clarifies that source/target semantics shift based on kind, which the schema's generic string types do not convey.

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 (connect two objects) and immediately constrains the surface with '(window backend only)'. It also distinguishes the two invocation modes (flow vs resource) with examples. It stops short of differentiating itself from connect-capable siblings such as flexsim_pf_connect, flexsim_agv_connect, flexsim_link_transporter, or flexsim_attach_resource.

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?

It explains when each kind applies (flow = item flow, resource = e.g. Processor asks Operator) and gives the important 'disconnect before reconnecting' precondition, which is real usage guidance. However, it never tells the agent when to pick this tool over the many connect-adjacent siblings, so routing remains inferred.

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