Skip to main content
Glama

Create report or dashboard

create_report

Create a new report or dashboard for a client. Presentation toggles have server defaults when omitted. A report is created on the grid layout or the free canvas; a dashboard is always grid.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesReport name
typeYesReport type
layoutNoLayout engine that owns widget geometry: 'grid' is the 12-column grid, 'canvas' is absolute page pixels. Defaults to 'grid'. Dashboards are always 'grid'. Set at creation only — a report cannot change engine afterwards, because its widget positions are stored in the units it was authored in.
passwordNoPassword (required when password_enabled is true)
templateYesBLANK (fresh), TEMPLATE (from a saved template), or AGENCY (account-level)
theme_idNoTheme ID (use list_themes to find one)
client_idYesClient ID the report belongs to (from list_clients)
date_rangeNoDate range configuration
descriptionNoReport description
pdf_enabledNoEnable PDF download
template_idNoWhen template is TEMPLATE, the source template ID — its pages and widgets are cloned into the new report. Use list_templates to find one.
show_cover_pageNoShow cover page
cover_page_titleNoCover heading, overriding the theme's. Null or omitted inherits the theme.
password_enabledNoEnable password protection
cover_page_subtitleNoCover subheading, overriding the theme's. Null or omitted inherits the theme.
thank_you_page_titleNoThank-you heading, overriding the theme's. Null or omitted inherits the theme.
cover_page_pattern_idNoGenerated artwork for the cover, overriding the theme's. Null or omitted inherits the theme.
show_table_of_contentsNoShow table of contents
thank_you_page_subtitleNoThank-you message, overriding the theme's. Null or omitted inherits the theme.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoThe new report — id, name, type and its pages (cloned from the template when one was named). Pass the id to list_pages, then add widgets.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • 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

A3.8/5.0
Behavior3/5

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

Annotations indicate readOnlyHint=false and destructiveHint=false, so the agent knows this is a mutating but non-destructive operation. The description adds useful context: presentation toggles have server defaults when omitted, and layout is constrained (dashboard always grid). However, it does not disclose other behavioral aspects such as error handling, idempotency, or authentication requirements. It adds moderate value beyond annotations, so a 3 is appropriate.

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 sentences, no filler. The core purpose is front-loaded, and the layout constraint and default behavior are stated efficiently. Every word earns its place. The description is appropriately sized for the tool's complexity.

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?

Despite having 19 parameters and nested objects, the description is minimal but the schema carries the heavy lifting with 100% coverage. The description adds the essential cross-cutting context (layout rules, server defaults) that the schema cannot express at the property level. An output schema exists, so return values do not need to be described. For a creation tool with this complexity, the description is reasonably complete, though it could mention that client_id and template_id reference list_clients and list_templates (though those are already in the schema).

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%, so all 19 parameters are documented in the schema. The description adds extra meaning by clarifying the layout parameter's behavior (dashboard always grid) and the default behavior of presentation toggles when omitted. This goes beyond the schema's individual property descriptions, which is valuable given the number of boolean toggles. This justifies a 4 rather than a baseline 3.

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 states a specific verb ('Create'), a clear resource ('a new report or dashboard for a client'), and adds distinguishing constraints (report can use grid or canvas, dashboard is always grid). It is immediately distinguishable from siblings like create_report_from_template, duplicate_report, and create_client_with_report without inspecting their schemas.

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 description provides no explicit guidance on when to use this tool versus alternatives. It does not mention that create_report_from_template should be used when cloning a template, or that duplicate_report is for copying an existing report. The only implied guidance is that this is the generic create tool, but that is not stated. An agent could confuse it with create_report_from_template because both create reports.

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