Skip to main content
Glama

Get a sample Flatscope report

get_sample_report
Read-onlyIdempotent

Return a full worked example of a Flatscope report as structured JSON, so you can show the user what the output looks like. Omit id to list the available samples. Zero cost, no analysis is run.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoOptional. Omit to list the available sample reports.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint. The description adds context that it's a sample with 'zero cost, no analysis is run', going beyond the annotations. No contradictions.

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?

The description is two sentences, with the main action front-loaded. Every word is informative: 'Return a full worked example...', 'Zero cost, no analysis is run.' No fluff.

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?

For a simple tool with one optional parameter and no output schema, the description sufficiently explains the return type ('structured JSON') and usage. It covers all needed context given the tool's simplicity.

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 explains the id parameter and its enum values. The description reiterates 'Omit id to list the available samples' but adds no new semantic detail 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?

The description clearly states it returns 'a full worked example of a Flatscope report as structured JSON', establishing a specific verb (return) and resource (sample report). It distinguishes from siblings like get_flat_analysis by noting 'zero cost, no analysis is run'.

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?

The description explicitly tells when to use: 'so you can show the user what the output looks like'. It also instructs 'Omit id to list the available samples' and clarifies 'Zero cost, no analysis is run' to prevent misuse for real analysis.

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