Swap an existing fabric in a CLO3D project with a new one by specifying its index and a .zfab file path.
Replace an existing fabric with a new one from file.
Args: fabric_index: Zero-based index of the fabric to replace. file_path: Absolute path to the replacement fabric file (.zfab).
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes | ||
| fabric_index | Yes |
Changes observed during successful MCP inspections.
v0.5.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations are absent, so description must disclose side effects. It states it replaces, implying mutation, but does not explain consequences (e.g., impact on pattern assignments, reversibility, permissions). Lacks detail on error conditions or state changes.
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?
Two concise bullet points with no fluff. The key action is stated first, parameters follow. Efficient and well-structured.
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?
For a simple two-parameter operation, it covers the essentials but omits any mention of return behavior or side effects on existing fabric references. Without annotations or output schema, an agent may need more context about the replacement's impact, though the tool is straightforward.
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?
Description adds meaning to both parameters: fabric_index is explicitly zero-based, file_path requires absolute path and .zfab extension. This goes beyond the bare schema and helps the agent format inputs correctly.
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?
States a specific verb 'Replace', resource 'existing fabric', and source 'from file'. Distinguishes from add_fabric and delete_fabric by implying replacement of an existing item. Clear and unambiguous.
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?
No guidance on when to use this vs alternatives like add_fabric or delete_fabric. Does not mention prerequisites such as fabric index validity or file existence. No exclusions or context for selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.