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
nameNoReport name
passwordNoPassword
theme_idNoTheme ID (use list_themes to find one)
report_idYesReport ID (from list_reports)
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.

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 (from list_reports)",
      -  "type": "string"
      -}
    • addedInput schema / properties / report_id
      Added value: +{
      +  "description": "Report ID (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. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the write-and-non-destructive profile is covered. The description adds one genuinely useful behavioral trait beyond the annotations: omitted fields are left untouched (PATCH semantics), but it stops there, with no disclosure of side effects, atomicity, or implications of passing null overrides.

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 sentence with zero filler, front-loaded with the verb and resource. It earns its place by conveying the key partial-update behavior, though for a 14-parameter tool the terseness borders on under-specification rather than disciplined brevity.

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 output schema and 100%-covered input schema carry most of the load, so the description needn't explain returns. However, it leaves untold when to prefer this over archive/duplicate/create report variants and what happens to theme overrides when fields are touched; adequate but leaning on structured data.

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%, and the schema already documents each parameter well, including null-clearing semantics for cover/text overrides and cross-references to list_themes and list_reports. The description adds no per-parameter meaning, only a tool-level note about partial updates, so the baseline 3 is appropriate.

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') and adds a distinguishing partial-update qualifier, which separates it from full-replacement update tools. The title's 'report or dashboard' introduces minor ambiguity since the description only mentions report, and the tool isn't differentiated against the many other update_* siblings beyond the resource name.

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

Usage Guidelines2/5

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

The only guidance is 'only include the fields you want to change,' which is partial-update semantics rather than when-to-use guidance. There is no direction on when to choose this over create_report, duplicate_report, archive_report, or update_theme, and no exclusions or prerequisites are stated.

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