Delete ruleset
delete_rulebookPermanently delete a ruleset and its rules, and detach it from every workflow connection.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the Ruleset. |
delete_rulebookPermanently delete a ruleset and its rules, and detach it from every workflow connection.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the Ruleset. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond that: the deletion is permanent (no undo) and cascades to child rules and workflow connections. It stops short of stating what happens on a non-existent id or that repeats fail.
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?
One sentence, front-loaded with the verb and resource, and every clause (rules removal, workflow detach) carries information. No waste or repetition of the title.
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 single-parameter destructive delete with full schema coverage and no output schema, the description covers the essentials: permanence and cascade effects. Minor gaps remain around behavior for an unknown/already-deleted id (relevant given idempotentHint=false).
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 description coverage is 100% (the single 'id' param is documented as 'Id of the Ruleset.'), so the schema carries the parameter burden. The description adds no syntax or format detail beyond that, making the baseline 3 appropriate.
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?
Specific verb (delete) plus resource (ruleset), with cascade scope spelled out: it also removes the ruleset's rules and detaches it from every workflow connection. That scope distinguishes it from the sibling delete_rule and create_rulebook/update_rulebook without needing the schema.
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 explicit when-to-use guidance, no mention of a non-destructive alternative (there is no archive_rulebook, but update_rulebook and delete_rule exist as adjacent choices), and no prerequisites such as required permissions. Only the adverb 'Permanently' hints at context.
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.