Delete a diagram
delete_diagramPermanently delete one of the user's diagrams by id. Requires a YAMLTools API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Diagram id to delete |
delete_diagramPermanently delete one of the user's diagrams by id. Requires a YAMLTools API key.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Diagram id to delete |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden and discloses the critical destructive nature ('Permanently delete') and an authentication requirement (API key). This goes beyond a basic 'delete' statement and communicates the irreversible action and access prerequisite.
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 short sentences with the action front-loaded. The first sentence states the operation and target; the second adds the required API key. No unnecessary words.
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 one-parameter delete operation with no output schema, the description covers the essential behavior, authentication requirement, and parameter. It could mention error behavior or idempotency, but these are not critical for basic usage and the description is sufficient.
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?
The input schema already documents the single 'id' parameter with 100% coverage. The description adds only marginal context ('one of the user's diagrams'), but essentially relies on the schema for parameter meaning.
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 'Permanently delete one of the user's diagrams by id' — a specific verb, resource, and scope. It distinguishes itself from sibling tools like update_diagram or get_diagram.
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 provides clear context: it is for permanently removing a diagram by id and requires an API key, which implies the appropriate usage scenario. It does not explicitly name alternatives or exclusions, but the sibling set makes the purpose obvious.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.