Skip to main content
Glama

Unpublish a Markdown Document

unpublish_article
DestructiveIdempotent

Disable a Markdown Document public link. Accepts natural workspace names and document titles; internal routing identifiers are optional. Requires publishing:write and explicit user confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contextYesDescribe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
articleIdNoInternal document identifier when already available. Omit it when the user referred to the document by title.
commandIdYesGlobally unique UUID for this logical publishing mutation. Generate it once and reuse the exact value if the tool call is retried.
workspaceIdNoOptional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces.
articleTitleNoHuman-visible document title. Prefer this over asking the user for an internal document identifier.
workspaceNameNoOptional workspace name to narrow document lookup. A unique document title can be used without a workspace choice.
confirmUnpublishYesMust be true after the user confirms that the public link should stop working.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
successYes
articleIdYes
publishIdYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.",
      +  "type": "string"
      +}
    • changedInput schema / properties / workspaceId / description
      Previous value: -"Internal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace."New value: +"Optional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces."
    • changedInput schema / properties / workspaceName / description
      Previous value: -"Human-visible workspace name. Prefer this over asking the user for an internal workspace identifier."New value: +"Optional workspace name to narrow document lookup. A unique document title can be used without a workspace choice."
    • changedInput schema / required
      Previous value: -[
      -  "commandId",
      -  "confirmUnpublish"
      -]New value: +[
      +  "commandId",
      +  "confirmUnpublish",
      +  "context"
      +]
  2. Changed2 schema fields changed
    • addedInput schema / properties / commandId
      Added value: +{
      +  "description": "Globally unique UUID for this logical publishing mutation. Generate it once and reuse the exact value if the tool call is retried.",
      +  "format": "uuid",
      +  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "confirmUnpublish"
      -]New value: +[
      +  "commandId",
      +  "confirmUnpublish"
      +]
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, openWorldHint=true and readOnlyHint=false, so the safety profile is covered. The description adds genuinely new context beyond them: the required publishing:write scope and the mandatory user-confirmation gate tied to confirmUnpublish. It still does not say what happens to the existing link/content after disabling.

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?

Three tight sentences with the action front-loaded, followed by argument guidance and then preconditions. No filler or repetition; every clause carries information.

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

Completeness4/5

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

With an output schema present, return values need not be explained, and annotations cover the mutation/intent profile. The description completes the picture with auth scope, confirmation flow, and argument flexibility, leaving only the post-unpublish effect (link invalidation consequences) unstated.

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 description coverage is 100%, so the baseline is 3. The description restates the naming model (natural titles/workspace names accepted, internal IDs optional) that the individual schema fields already document, so it adds little meaning the schema does not already carry.

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

Purpose4/5

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

The description gives a concrete verb and resource: 'Disable a Markdown Document public link', which is unmistakably the inverse of the sibling publish_article. It is clear on its own, though it never names the counterpart tool explicitly, so the agent must infer the pairing from the tool name rather than the text.

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

Usage Guidelines3/5

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

It supplies invocation context ('Accepts natural workspace names and document titles; internal routing identifiers are optional') and a precondition ('Requires ... explicit user confirmation'), which implies when the tool is callable. It does not, however, state when to choose this over publish_article or get_publish_status, nor any exclusion conditions.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources