hex-delete-guide-draft
Removes a guide draft from a Hex workspace by its ID, helping keep guide content accurate and current.
Instructions
Delete a guide draft by ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orgGuideFileId | Yes |
Removes a guide draft from a Hex workspace by its ID, helping keep guide content accurate and current.
Delete a guide draft by ID.
| Name | Required | Description | Default |
|---|---|---|---|
| orgGuideFileId | Yes |
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden for a destructive mutation. It says nothing about irreversibility, required permissions, whether published versions are affected, or error behavior when the ID doesn't exist.
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?
A single short sentence with the action front-loaded and no filler. Its brevity is appropriate for the tool's simplicity, though that brevity is also the source of its gaps.
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 destructive, single-parameter tool with no annotations and no output schema, the description leaves out consequences of deletion and permission requirements. An agent has enough to issue the call but not enough to judge when it is safe to do so.
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 0% for the single orgGuideFileId parameter, and the description only offers the generic phrase 'by ID'. It does not clarify whether this is a guide ID, file ID, or org guide file identifier, nor any format expectations.
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 (Delete) and resource (guide draft), which distinguishes it from siblings like hex-upsert-guide-draft, hex-list-draft-guides, and hex-publish-guide-drafts. It stops short of 5 because 'by ID' adds no distinguishing detail.
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 delete versus upserting or publishing a draft, and no mention of prerequisites or alternatives among the guide-draft siblings. Usage is only implied by the verb.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.