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. A failure comes back as an error result instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations only indicate readOnly=false and destructive=false, so the description adds real behavior: presentation toggles fall back to server defaults and dashboards are forced onto grid layout. It does not describe return values or cloning side effects, but the output schema exists and the core creation behavior is disclosed.

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 concise, front-loaded sentences each carry meaningful information: creation scope, default handling, and layout rules. There is no filler or restating of the tool 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?

For a 19-parameter creation tool the description is adequate but leaves the relationship to create_report_from_template and create_client_with_report unstated. The schema covers parameter detail and an output schema exists, but the description itself is thin on process and alternative selection.

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 coverage is effectively 100%, so the schema does the heavy lifting; the description still adds a useful general guarantee that omitted presentation toggles are allowed and that layout has a fixed default. This supplements, rather than repeats, the per-property documentation.

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 states a specific action ('Create a new report or dashboard for a client') and names the resource, so an agent can see this is the general creation entry point. It does not explicitly distinguish itself from the overlapping sibling create_report_from_template, though it does cover report/dashboard and grid/canvas behavior.

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?

There is no when-to-use or when-not-to-use guidance and no mention of alternatives such as create_report_from_template or create_client_with_report. Since this tool itself accepts a template_id, an agent gets no routing signal for choosing between overlapping creation tools.

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