Lists RAPID modules in a specified RobotStudio task, helping you inspect available code modules before editing or debugging.
List RAPID modules in a task (SDK)
| Name | Required | Description | Default |
|---|---|---|---|
| task | Yes | Task name, e.g. 'T_ROB1' |
Changes observed during successful MCP inspections.
v3.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must bear the full burden. It offers no insights into side effects, permissions, error handling, or output format beyond the basic listing.
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 a single, complete sentence with no wasted words, perfectly sized for the tool's simplicity.
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?
Given no output schema and no annotations, the description is minimally adequate for a simple list operation but lacks details on return value format and behavior when task is invalid.
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 100% with a description for the single parameter 'task' (e.g., 'T_ROB1'). The description adds no additional semantics beyond the example, so stays at baseline.
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 the verb 'List' and the resource 'RAPID modules in a task', with context 'SDK'. It distinguishes from sibling tools like rs_read_module and rws_get_modules.
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 implies SDK usage via parentheses but provides no explicit when-to-use or when-not-to-use guidance against siblings like rws_get_modules.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.