Skip to main content
Glama

Unpublish canvas

unpublish_canvas
Destructive

Take a published canvas page down. Its URL answers 410 from then on; publishing the same artifact again later restores it at the same URL. Pass the publication_id publish_canvas returned (or the id from the organisation's published pages list).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "publication_id": "<publication_id>"
    },
    "name": "unpublish_canvas"
  }
}

Input Schema

NameRequiredDescriptionDefault
publication_idYesThe publication_id publish_canvas returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: it discloses the post-condition (URL returns 410 from then on) and the reversibility path (republishing restores the same URL), which materially softens the destructiveHint=true label with concrete recoverability information. Annotations cover the safety flags but not these outcome semantics.

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 short sentences, front-loaded with the action, then the consequence, then the parameter guidance. No filler or repetition.

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?

For a single-parameter mutation with no output schema, the description covers purpose, side effect, reversibility, and parameter sourcing. The one omission is behavior on repeat calls — idempotentHint=false implies a second call on an already-unpublished page fails, which the definition never states.

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

Parameters4/5

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

Schema description coverage is 100% and already explains publication_id as the value returned by publish_canvas. The description still adds meaning by naming a second legitimate source — the organisation's published pages list — which the schema does not mention.

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?

States a specific verb and resource ('Take a published canvas page down') and implicitly frames the inverse of publish_canvas, so an agent can tell the two apart immediately. The name/title is not merely restated — the scope (a published page) is explicit.

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?

The opening sentence establishes the situation for use (a page currently published that must be taken down), and the third sentence routes the agent to publish_canvas or the published pages list for the required id. It stops short of stating exclusions, e.g. what to do if the artifact was never published or is already down.

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.