Skip to main content
Glama

Archive report or dashboard

archive_report
Destructive

Archive a report by ID. Its pages and widgets stay attached and come back with it. It goes to the archive, not away — list_archive shows it and restore_from_archive brings it back.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
report_idYesReport ID to archive (from list_reports)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoConfirmation that the report was archived. Its pages and widgets go with it and return with it.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedInput schema / properties / id
      Removed value: -{
      -  "description": "Report ID to archive (from list_reports)",
      -  "type": "string"
      -}
    • addedInput schema / properties / report_id
      Added value: +{
      +  "description": "Report ID to archive (from list_reports)",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "id"
      -]New value: +[
      +  "report_id"
      +]
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / success / description
      Previous value: -"True when the call succeeded. A failure comes back as an error result instead."New value: +"True when the call succeeded."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "description": "Confirmation that the report was archived. Its pages and widgets go with it and return with it."
      +    },
      +    "success": {
      +      "description": "True when the call succeeded. A failure comes back as an error result instead.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations mark destructiveHint=true, but the description adds meaningful context beyond that: it clarifies the archive is reversible ('goes to the archive, not away'), that pages and widgets remain attached, and that list_archive and restore_from_archive are the recovery paths. This enriches the agent's understanding of the operation's effects.

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?

Two tight sentences. The core action is front-loaded, and the clarifying details about persistence and recovery are added without waste.

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?

The description fully covers what an agent needs to know for a single-parameter archive operation: the target, the effect on contents, and how to reverse it. With an output schema present and no nested complexity, nothing essential 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?

Schema coverage is 100% and the schema description for report_id already specifies it comes from list_reports. The tool description adds no further parameter details, so baseline 3 applies.

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: 'Archive a report by ID.' It also clarifies scope by noting pages and widgets stay attached, and names related sibling tools (list_archive, restore_from_archive) that make its purpose distinct from other archive tools.

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?

The description implies usage for reports and explains the reversible nature, but does not explicitly contrast with sibling archive tools like archive_asset or archive_reports (plural). It gives context on what happens after archiving but no explicit when/when-not 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