Skip to main content
Glama

xae_placeholder_add

Idempotent

Adds a TwinCAT placeholder to an IEC project and assigns its default library, filling missing distributor or version details. Use it to define placeholder targets for library-linked dependencies.

Instructions

Add a placeholder (AddPlaceholder) with its default library (library '' = the device's placeholder of that name; a library's missing distributor / version is completed as in xae_library_add). target=':'.

Input Schema

NameRequiredDescriptionDefault
libraryNo
versionNo
distributorNo
placeholderYes
confirm_tokenNo
plc_project_pathNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.8.19

TDQS

B3/5.0
Behavior3/5

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

The annotations already declare that this is a non-read-only, idempotent, non-destructive mutation. The description adds useful behavioral context about default library handling and missing distributor/version completion, but it does not explain confirm_token, permission requirements, or side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and front-loads the core action: adding a placeholder. The target-format note is useful but slightly cryptic, and the parenthetical default-library explanation is dense.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is a mutation with six parameters and 0% schema description coverage, so more context would help. The annotations and output schema reduce the burden, and the description covers key default-library semantics, but it is incomplete on usage, confirmation behavior, and several parameters.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry parameter meaning. It explains library '' default behavior and how missing distributor/version are completed, and it mentions target formatting, but it leaves most of the six parameters—especially confirm_token and plc_project_path—undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: adding a placeholder via AddPlaceholder, including default-library semantics and target formatting. It clearly distinguishes the operation itself, though it does not explicitly differentiate it from sibling tools such as xae_placeholder_resolve or xae_placeholder_freeze.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description does not state when to use this tool versus xae_placeholder_resolve, xae_placeholder_freeze, or xae_library_add. It explains one default-library behavior but provides no when-to-use or when-not-to-use guidance.

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

Deploy Server

Other Tools