Skip to main content
Glama

Get VCR example

get_vcr_example

Returns a complete, valid sample verification case record as raw markdown, including frontmatter and body, to demonstrate every section for learning.

Instructions

Return a complete, valid sample verification case record document as raw markdown -- frontmatter and body -- exercising every section, for use as a learning example.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.36.0

TDQS

A3.9/5.0
Behavior4/5

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

No annotations, so the description carries the burden, and it discloses two meaningful traits: the output is raw markdown (frontmatter plus body) and covers every section. It doesn't state whether the data is live or static, but otherwise covers what an agent needs to know about the return.

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?

A single compact sentence front-loads the verb and resource, then qualifies format and scope with no waste.

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?

An output schema exists, so return-value details needn't be spelled out. The description supplies the key missing context — markdown format and exhaustive section coverage — good enough for a static example tool, though it could note that the output is not real record data.

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?

Zero parameters, so parameter semantics is trivially complete. Baseline 4 for no-params tools.

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+resource (return a sample VCR record document) and describes the content ('exercising every section'). It clearly distinguishes itself from get_vcr (the actual record) and get_vcr_template (the blank template), though the prefixed naming convention already signals this.

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?

The phrase 'for use as a learning example' implies the when-to-use context (study/learn format vs. fetch real data), but there are no explicit exclusions or named alternatives like get_vcr or get_vcr_template.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.