Skip to main content
Glama
cadcraft-electrical-mcp

cadcraft-electrical-mcp

plc_io_assign

Assigns PLC channels to field devices, auto-filling I/O addresses and module terminals when omitted and validating channel counts against the catalog.

Instructions

Assign PLC channels to field devices. Address (%I0.0, %Q0.0, %IW64) and module terminal (DIa.0, DQa.0 ... from the catalog) are auto-assigned when omitted; channel count is checked against the catalog.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "plc": "<plc>",
      "channels": "<channels>"
    },
    "name": "plc_io_assign"
  }
}

Input Schema

NameRequiredDescriptionDefault
plcYes
channelsYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare a non-read-only, non-destructive, non-idempotent, closed-world mutation. The description adds real context beyond that: address and terminal are auto-derived from the catalog when omitted, and channel counts are validated against the catalog. It stops short of saying what happens on repeated calls or whether an existing assignment is replaced, which matters given idempotentHint=false.

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?

Two sentences, front-loaded with the action and followed by the auto-assignment/validation rules. No filler, though the parenthetical examples make the second sentence denser than ideal.

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

Completeness4/5

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 no explanation. For a mutation tool the description covers the key defaults and validation, but leaves gaps around overwrite behavior and whether repeated calls duplicate channels.

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

Parameters3/5

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

Schema description coverage is effectively 0% at the top level, so the description must carry the load. It usefully explains the address format (%I0.0, %Q0.0, %IW64) and terminal format (DIa.0, DQa.0 from the catalog) and that both default when omitted, but it says nothing about the 'plc' parameter (name vs. identifier) or the required 'kind' field on each channel.

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 ('Assign PLC channels to field devices'), which clearly separates it from read/remove siblings like plc_io_list and plc_io_remove. It does not explicitly name those alternatives, so it stops short of a 5.

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

Usage Guidelines3/5

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

Usage is implied by 'Assign PLC channels to field devices', but there is no explicit when-to-use versus when-not-to-use guidance, nor any mention of prerequisites such as the PLC or devices already existing. The auto-assignment note hints at how to call it but not when to prefer it over alternatives.

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