Skip to main content
Glama

Get Report Review Envelope

get_report_review_envelope
Read-onlyIdempotent

Read one owned frozen review record and source hash without rebuilding its definitions. No declaration or permission to share is inferred. Requires tickets:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
envelope_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is low; the description nonetheless adds the auth requirement ('Requires tickets:read'), the non-rebuild behavior, and the explicit caveat that no share declaration is inferred. These are real disclosures beyond the structured hints, though return/pagination behavior is not covered.

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?

Three tight sentences, purpose front-loaded, no filler. The third sentence is slightly cryptic but earns its place as a semantic boundary rather than padding.

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?

No output schema exists, so the description must carry return context; it does name the payload (frozen review record and source hash) and the permission needed. The undefined 'envelope' concept and lack of any error/ownership-failure behavior keep it short of complete.

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?

One required parameter with 0% schema description coverage. The description implies envelope_id selects a single 'owned' record and that ownership matters, but adds no format or sourcing detail beyond the uuid already given by the schema, so it only partially compensates for the coverage gap.

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 (read) and resource (one owned frozen review record plus its source hash), with the 'one' distinguishing it from the list_report_review_envelopes sibling and 'without rebuilding' separating it from create/export. The domain term 'envelope' is never defined, but the operation and its object are clear.

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?

Usage is only implied: fetch a single record by id. It names no alternative such as list_report_review_envelopes or create_report_review_envelope and gives no condition for choosing this tool, though the boundary clauses ('without rebuilding', 'no . . . inferred') gesture at scope.

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