Skip to main content
Glama

supportpages_delete_article

Destructive

Soft-delete a support article using its expected revision only when deletion is requested; retention and browser restoration apply, so do not recreate via upload or retry.

Instructions

Soft-delete the selected article using its latest revision. Use only when the user requests deletion. Existing retention and browser restoration apply; never recreate it through upload or retry.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceNo
article_idYes
expected_revisionYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.7

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and readOnlyHint=false, but the description adds valuable context: soft-delete behavior, retention/browser restoration, and a warning not to recreate the article through upload or retry. "Soft-delete" qualifies the destructive nature rather than contradicting the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded and compact, with three short sentences that each add distinct information. There is no filler or repetition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has an output schema and annotations covering the destructive profile, so return values and safety are reasonably covered. However, with 0% schema description coverage, the description should explain all three parameters more fully; the optional workspace and expected_revision usage remain under-documented.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate. It implies the selected article and latest revision for the two required parameters, but it omits the optional workspace parameter and does not explain expected_revision beyond the phrase "latest revision." This is partial compensation, not full coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource: "Soft-delete the selected article." It also distinguishes the action from sibling tools like unpublish_article and update_article by specifying deletion semantics.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states an explicit when-to-use condition: "Use only when the user requests deletion." However, it does not name alternatives such as unpublish_article for cases where the user wants to hide but retain content.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.