Skip to main content
Glama
cadcraft-electrical-mcp

cadcraft-electrical-mcp

plc_io_list

Read-onlyIdempotent

Lists PLC I/O assignments, optionally filtered to one PLC, to support review and documentation of control system inputs and outputs.

Instructions

List I/O assignments (optionally of one PLC).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "plc_io_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
plcNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered without the description. The description adds only the optional single-PLC scoping fact and says nothing about result size, ordering, or pagination behavior. With annotations carrying the behavioral burden, a 3 is appropriate.

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?

A single short sentence with zero filler and the key scoping qualifier front-loaded. It borders on under-specified rather than verbose, which is the right direction for conciseness.

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?

An output schema exists, so return values need not be explained, and rich annotations cover safety. For a one-optional-parameter read tool the description is minimally viable, but it leaves the parameter's accepted format and the scope of results unaddressed.

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 0% for the single 'plc' parameter, so the description must compensate. It does add real meaning by stating the filter is optional and scopes to one PLC, but it gives no hint about accepted identifier format (name vs. path) or what happens when the parameter is omitted.

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?

States a specific verb ('List') and resource ('I/O assignments'), with the parenthetical '(optionally of one PLC)' narrowing the scope. It is clearly distinguishable from siblings such as plc_io_assign and plc_io_remove, though it does not name or route to them.

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?

There is no explicit when-to-use or when-not guidance, and no alternative is named. The optional PLC scoping is implied by the parenthetical, but an agent must infer that assignment listings are the read-side counterpart to plc_io_assign.

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