Update or create guide drafts by filePath using arrays of filePath and content, enabling MCP clients to keep Hex workspace guides current.
Update or create guide drafts by filePath.
| Name | Required | Description | Default |
|---|---|---|---|
| guides | Yes | Array of { filePath, content } objects |
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. 'Update or create' usefully discloses upsert semantics, but it never states what happens to an existing draft's content, whether changes are destructive, permission requirements, or how drafts relate to publishing.
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 front-loaded sentence with no filler; the verb and the identifying key come first. It is efficient, though almost to the point of under-specification.
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 write/upsert tool with no annotations and no output schema, the description omits side effects, overwrite behavior, and error conditions. An agent can infer the payload from the schema but not the consequences of calling it.
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 100% and there is only one parameter, so the schema already documents the {filePath, content} shape. The description references filePath as the key but adds no format, path syntax, or content expectations beyond the schema.
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?
Names a specific verb pair (update or create) and resource (guide drafts), plus the identifying key filePath. It is distinguishable from siblings like hex-delete-guide-draft and hex-list-draft-guides, though it does not explicitly name them.
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 versus the other guide tools (list, delete, publish). The upsert behavior is implied by 'update or create' but the conditions that select each branch are never stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.