tc_mapping

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

With no annotations, the description carries full burden and excels: discloses read-only nature of produce, mutation scope of consume, destructive guarded nature of clear, that operations affect offline config only, and safety implications for TwinSAFE links. It also notes the XML schema is undocumented, setting proper expectations.

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 detailed but not overly verbose; it front-loads the purpose and method, then explains each action, safety, and notes. Some redundancy exists (repeating 'PROJECT-WIDE', 'NOT runtime writes'), but overall each sentence adds value given the complexity of the tool.

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 tool with 4 parameters, no output schema, and no annotations, the description covers all essential aspects: operation semantics, parameter roles, safety precautions, scope, and even advises on handling the unknown XML schema. The return value of produce is explicitly stated. No gaps remain for an agent to operate correctly.

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%, so description must explain parameters. It does so by associating 'xml' with produce output and consume input, 'save' as optional for consume/clear, 'action' enum fully explained, and 'confirm' required for clear. While not a structured parameter list, it effectively conveys usage context. Minor improvement would be explicit mapping of each parameter to its operation.

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 it handles bulk variable-mapping operations (produce, consume, clear) on the entire TwinCAT project, not individual links. It mentions being whole-project and not tree-path specific. However, it does not explicitly differentiate from sibling tool 'tc_link', which likely handles individual link operations, leaving some ambiguity for the agent.

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 detailed context for each operation: produce is read-only, consume mutates offline config, clear is destructive with a required confirmation token. It advises running produce first as a backup and warns about TwinSAFE involvement. However, it lacks explicit guidance on when to use this tool versus sibling tools like tc_link for individual mappings.

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