studio5000-mcp-server

list_modules

List all I/O modules in an L5X project, including catalog numbers and slot assignments, to inventory PLC hardware.

Instructions

List all I/O modules in an L5X project with catalog numbers and slot assignments.

Args: l5x_path: Path to a .l5x file.

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": {
      "l5x_path": "<l5x_path>"
    },
    "name": "list_modules"
  }
}

Input Schema

Name	Required	Description	Default
`l5x_path`	Yes

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.4.0Oct 20, 2026

TDQS

B3/5.0

Behavior3/5

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

No annotations are provided, so the description carries the full burden. 'List' implies a read-only enumeration and it discloses the returned content, but it says nothing about failure modes (invalid/missing .l5x path), permissions, or scale. Adequate but thin for an unannotated tool.

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?

Front-loaded purpose sentence followed by a minimal Args block; very little waste. The Args line is largely redundant with the schema, which keeps it from a 5.

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 no explanation, and the tool is single-parameter and simple. However, with no annotations and no usage or error context, an agent still lacks guidance on preconditions and failure behavior.

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% for the single required parameter, so the description must compensate. 'l5x_path: Path to a .l5x file' only restates what the parameter name already implies, adding no format, constraint, or example detail.

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 and resource ('List all I/O modules in an L5X project') and even names the returned fields (catalog numbers, slot assignments). The resource is unique among the get_*/search_* siblings, so it is distinguishable, though no sibling is explicitly referenced.

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 when-to-use guidance, no prerequisites (e.g., whether the project must be loaded first), and no named alternative. Usage is only implied by the tool's name and scope.

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

Deploy Server