Remove files from QuantConnect algorithmic trading projects to manage strategy code and maintain organized workspaces.
Delete a file in a project.
| Name | Required | Description | Default |
|---|---|---|---|
| model | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | List of errors with the API call. | |
| success | No | Indicate if the API request was successful. |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotation idempotentHint: true is the primary behavioral clue, but the description does not add any extra context beyond stating it deletes a file. No mention of irreversibility or authorization needs.
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?
Single sentence, no redundancy. Efficiently communicates the core action.
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 the complexity of the tool (delete operation with multiple parameters) and lack of output schema details, the description is too minimal. It should mention consequences (irreversible) or constraints (e.g., file must exist in project).
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?
Although the input schema has descriptions for nested properties, the top-level model parameter lacks description (0% coverage). The tool description does not compensate by explaining the parameter structure.
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 'Delete a file in a project.' uses a specific verb ('Delete') and resource ('file in a project'), clearly distinguishing it from sibling tools like read_file or update_file_contents.
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 tool versus alternatives (e.g., patch_file or update_file_contents). Lacks context on prerequisites or when deletion is appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.