tc_mapping

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

With no annotations provided, the description fully discloses the read-only nature of produce, the mutation of consume, and the destructive nature of clear (guarded by confirm). It also highlights safety concerns with TwinSAFE links and the undocumented XML schema, providing comprehensive behavioral context.

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 thorough but somewhat lengthy with complex sentences. It is well-structured into actions and safety notes, but could be more concise without losing essential details. The length is justified by the tool's complexity.

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?

The description explains the produce action's return (raw XML) but does not specify return values for consume and clear. Error conditions and exact output format are not detailed. Overall, it provides enough context but leaves some gaps in expected 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?

The input schema has 0% description coverage, but the description compensates by explaining the meaning of each parameter: the action enum values, the xml blob for consume, the confirm string for clear, and the optional save flag. This significantly aids understanding beyond the bare schema.

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 identifies the tool as for bulk variable-mapping operations on the loaded TwinCAT project, listing three distinct actions (produce, consume, clear) with specific verbs and scope. It distinguishes itself from sibling tools by emphasizing whole-project operations without a tree path.

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?

The description provides explicit guidance on when to use each action, such as running produce first as a backup, and notes that these are project-wide config-tree ops, not runtime writes. It does not mention alternatives directly, but the detailed action descriptions and safety instructions help the agent decide appropriately.

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