Skip to main content
Glama

Report templates: one template's structure

report_template_get
Read-onlyIdempotent

One saved report template's structure and style, to follow when building a report with fresh numbers (then create_client_report with template set to its name). Reads only.

Input Schema

NameRequiredDescriptionDefault
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so 'Reads only' mostly restates what is structured. The description's genuine addition is the workflow relation to create_client_report, but it says nothing about behavior for a missing/unknown template name, which matters for a lookup tool.

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?

One sentence, front-loaded with what it returns and the workflow tacked on as a parenthetical. Efficient, though the nested parentheses make it slightly denser than needed.

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 read-only, single-parameter getter with full annotation coverage and no output schema, the description covers purpose, return content, and next step. Only the name-resolution edge cases are missing, which is a minor gap at this complexity.

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 coverage is 0% — the single 'name' parameter carries no description, maxLength 80 only. The phrase 'set to its name' implies the parameter identifies a template by its name, which is marginally useful, but matching semantics (exact string, case sensitivity, unknown-name behavior) are left unstated.

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 names a specific verb-resource pair ('one saved report template's structure and style') and states what the return contains, which cleanly separates it from sibling list tool report_templates. It stops short of explicitly naming those siblings, so an agent still has to infer the distinction.

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

Usage Guidelines4/5

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

It gives a concrete usage context ('to follow when building a report with fresh numbers') and names the downstream call plus how to wire it ('create_client_report with template set to its name'). No exclusions or alternatives (e.g. vs report_templates or report_style) are given, so it is clear but not exhaustive.

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.