Skip to main content
Glama

get_report

Read-onlyIdempotent

Get one workspace report by id. Includes panel queries for Staff MCP and editors with report authoring enabled; otherwise queries are omitted. Use when inspecting a dashboard definition.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
idYesReport id

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds a real behavioral trait beyond them: panel queries are conditionally included based on whether the caller is Staff MCP or an editor with report authoring enabled. That conditional payload behavior is exactly what an agent needs to interpret a possibly-truncated response.

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 short sentences, front-loaded with the core action, then the conditional return behavior, then the usage cue. No redundant restatement of the title and no filler.

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?

For a simple one-parameter read tool with no output schema, the definition covers the action, the identifier, and the key variability in the returned payload. Minor gaps remain (what happens if the id is unknown, whether authoring permission failures are surfaced), but nothing essential to calling it is missing.

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?

Only one parameter exists and schema description coverage is 100% ("Report id"), so the schema already carries the meaning. The description restates 'by id' without adding format, source, or lookup guidance, which is the expected baseline here.

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?

States a specific verb and resource ("Get one workspace report by id") with clear singular scope, which distinguishes it from list/version siblings. It stops short of explicitly naming an alternative such as list_report_versions, but an agent can tell this is a single-record fetch.

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?

Adds one usage cue, "Use when inspecting a dashboard definition," which implies the read/inspection context. There are no exclusions or pointers to sibling tools for listing, versioning, or updating reports, so guidance is implied rather than explicit.

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