Skip to main content
Glama

Show report

show_report
Read-only

Show an analysis/dashboard from saved CRM records as a card with "Save as view", or text if unavailable/requested. report_id runs a saved report definition; definition runs an inline ReportSpec/composition. Resolve named subjects in their own object and include exact supported filters (company name/domain); a title never scopes data. For an attached report, give one line without repeating rows. Own reading: run_report. Showing saves nothing. Save only when asked via create_record with object_type:"report", data:{name,definition:returned spec}. Never tell the user a View is saved before success. Revisions pass source_view_id to update the existing View. Say when zero rows match. Money is minor units, not automatically converted totals. Shape: capable://guide/reports.

When to use: The user asks to see, chart or keep an analysis.

Example: Show ARR by industry.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "show_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
report_idNoA saved analysis or dashboard's id (uuid), run with its stored definition; give this or definition — report_id wins when both are passed.
definitionNoInline ReportSpec/composition; same shape as run_report's definition. Preserve requested scope in filters, e.g. [{ref:{kind:'field',field:'name'},op:'eq',value:'Acme'}]. Omit with report_id.
source_view_idNoId (uuid) of the saved View this inline definition refines, so a save updates it in place instead of creating a twin; ignored with report_id.
suggested_nameNoOptional title for a later save; never filters records. Inline definitions only.

Output Schema

NameRequiredDescriptionDefault
vizNo
kindNo
modeNo
noteNo
rowsNo
specNo
emptyNo
titleNo
objectNo
columnsNo
widgetsNo
row_countNo
truncatedNo
source_view_idNo
suggested_nameNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / definition / description
      Previous value: -"The inline ReportSpec or composition (dashboard) to show — the same shape as run_report's definition; omit when passing report_id."New value: +"Inline ReportSpec/composition; same shape as run_report's definition. Preserve requested scope in filters, e.g. [{ref:{kind:'field',field:'name'},op:'eq',value:'Acme'}]. Omit with report_id."
    • changedInput schema / properties / suggested_name / description
      Previous value: -"A name to seed the card's \"Save as view\" button, echoed as suggested_name; only meaningful with an inline definition (this call saves nothing)."New value: +"Optional title for a later save; never filters records. Inline definitions only."
  2. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  3. Changed2 schema fields changed
    • removedInput schema / properties / report_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • removedInput schema / properties / source_view_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
  4. Changed10 schema fields changed
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / columns / items / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / columns / items / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / rows / items / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / rows / items / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / spec / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / spec / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / widgets / items / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / widgets / items / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
  5. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false; the description reinforces this ('Showing saves nothing') rather than contradicting it. It goes well beyond annotations: it warns never to tell the user a View is saved before success, requires stating when zero rows match, and notes money is in minor units without automatic conversion.

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?

The purpose is front-loaded and each operational rule (no save, no premature confirmation, zero-row messaging, minor units) earns its place. It is dense and slightly crammed, but there is little filler.

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?

An output schema exists, so return-value detail is unnecessary; the description instead covers save workflow, revision handling, and scoping caveats, and points to capable://guide/reports for the full shape. Complete for an agent to call it correctly.

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 100%, so parameters are already documented; the description still adds precedence detail (report_id wins over definition) and the scope rule that a title never filters data. It stops short of clouding parameter behavior further, adding modest value beyond the schema.

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 (show) and resource (an analysis/dashboard from saved CRM records) with two render modes (card with 'Save as view', or text). It explicitly routes reading to the sibling run_report, so the agent can distinguish it without opening either schema.

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

Usage Guidelines5/5

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

Provides an explicit 'When to use' line, an example, and unambiguous sibling routing: 'Own reading: run_report', 'Save only when asked via create_record'. Also gives the alternative path for revisions (source_view_id to update an existing View). Nothing is left to inference.

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