Skip to main content
Glama

Update report or dashboard

update_report

Update a report — only include the fields you want to change

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesReport ID (from list_reports)
nameNoReport name
passwordNoPassword
theme_idNoTheme ID (use list_themes to find one)
descriptionNoReport description
pdf_enabledNoEnable PDF download
show_cover_pageNoShow cover page
cover_page_titleNoCover heading, overriding the theme's. Null clears the override and inherits the theme again.
password_enabledNoEnable password protection
cover_page_subtitleNoCover subheading, overriding the theme's. Null clears the override and inherits the theme again.
thank_you_page_titleNoThank-you heading, overriding the theme's. Null clears the override and inherits the theme again.
cover_page_pattern_idNoGenerated artwork for the cover, overriding the theme's. Null clears the override and inherits the theme again.
show_table_of_contentsNoShow table of contents
thank_you_page_subtitleNoThank-you message, overriding the theme's. Null clears the override and inherits the theme again.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoThe report as saved, with every field after the update applied.
successYesTrue when the call succeeded. A failure comes back as an error result instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "additionalProperties": {},
      +      "description": "The report as saved, with every field after the update applied.",
      +      "type": "object"
      +    },
      +    "success": {
      +      "description": "True when the call succeeded. A failure comes back as an error result instead.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations (readOnlyHint=false, destructiveHint=false) already establish that this is a mutating but non-destructive operation. The description adds the partial-update behavior, but does not cover side effects, validation, or return behavior.

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

Conciseness4/5

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

A single, front-loaded sentence with no filler. It earns its place but is terse for a 14-parameter tool with a dashboard scope in the title.

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 schema and output schema carry most of the load, but the description omits the 'dashboard' scope from the title and gives no usage context. It is minimally viable but leaves the agent to infer when this tool is the right choice.

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?

Input schema describes all 14 parameters, so the description has little to add. 'Only include fields you want to change' usefully clarifies that all fields except id are optional, which is implied but not spelled out in the schema.

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 names a specific verb and resource ('Update a report'), immediately locating the operation among many update_* siblings. It does not mention the 'dashboard' scope found in the title, so the full scope is only partially stated.

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 instruction 'only include the fields you want to change' gives a useful partial-update guideline and implies that omitted fields remain unchanged. However, it does not state when to prefer this over sibling update tools or provide exclusions.

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