Skip to main content
Glama

Unpublish dashboard

unpublish_dashboard
DestructiveIdempotent

Make a public dashboard private again. Its status page, wallboard and any domain serving it stop loading for visitors right away; the dashboard and its checks are kept. Needs the dashboards:unpublish permission, which is off unless granted when the connection is approved. Returns the dashboard with its public links set to null.

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": {
      "id": "<id>"
    },
    "name": "unpublish_dashboard"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDashboard id (dash_…).

Output Schema

NameRequiredDescriptionDefault
idYes
nameYes
publicYes
defaultYes
editableYes
settingsYes
domain_urlYes
public_urlYes
domain_wallboard_urlYes
public_wallboard_urlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations flag destructiveHint=true and idempotentHint=true, but the description adds the crucial scoping detail that the dashboard and its checks are retained, so an agent knows the destruction is limited to public exposure rather than data. It also discloses immediate effect on status pages, wallboards, and custom domains, plus the auth requirement and the returned shape (public links set to null).

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, front-loaded with the state transition, then consequences, then permission, then return value. Every sentence carries new information and none repeats the title or schema.

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

Completeness5/5

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

For a one-parameter mutation with an output schema, the description covers the operation, its side effects, its retention behavior, the permission gate, and the response shape. Nothing an agent needs in order to invoke it correctly is missing.

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?

The single parameter is fully documented in the schema ("Dashboard id (dash_…)", with length bounds), and the description adds nothing further about the id argument. With schema coverage at 100% and only one parameter, the schema carries the semantics entirely, making the baseline of 3 appropriate.

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 opens with a specific verb and resource ("Make a public dashboard private again"), which is the exact inverse of the sibling publish_dashboard and immediately tells an agent which of the two to call. No ambiguity about what state transition is being performed.

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?

Usage context is clear from the framing (revoking public access) and a concrete prerequisite is given: the dashboards:unpublish permission, which is off unless granted at connection approval. It does not explicitly name publish_dashboard as the counter-operation or state when-not-to-use, so it stops short of full routing guidance.

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