twincat_restart_runtime

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

With no annotations, the description carries full transparency burden. It reveals the guarded nature ('confirm=ALLOW_TWINCAT_RESTART'), indicating a safety-conscious operation. However, it does not disclose side effects like stopping PLC programs, network interruptions, or state changes to the runtime system, leaving gaps in understanding the full impact.

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 description is extremely concise—two sentences covering purpose and guard condition. No redundant information; every word earns its place.

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?

For a simple restart tool, the description covers purpose and guard but lacks details about prerequisites (e.g., runtime must be active), post-restart behavior, or return values. Since there is no output schema, the description could usefully indicate that the tool returns success/failure or triggers a reboot, but it does not. Still, the core functionality is adequately conveyed.

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?

The schema only defines 'confirm' as a string with no description. The description adds critical meaning by specifying the exact required value 'ALLOW_TWINCAT_RESTART', which is essential for correct invocation. This compensates for the 0% schema description coverage.

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 clearly states the verb 'start/restart' and the resource 'TwinCAT runtime on the target', making the tool's purpose unambiguous. It also implicitly distinguishes from sibling tools like 'xae_build' or 'plc_download' which handle different operations.

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?

No guidance on when to use this tool vs. alternatives like 'twincat_activate_configuration' or 'tc_system'. The description does not mention prerequisites, context of use, or scenarios where this tool is appropriate versus other runtime management tools.

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