Skip to main content
Glama

Create verification case record

create_vcr

Create a new verification case record by assigning a fresh id, deriving the filename from its H1 title, and validating and saving the document; returns frontmatter only, and invalid content returns an error without writing.

Instructions

Create a new verification case record: assigns a fresh id, derives a filename from the body's H1 title, validates the submitted body-only content, and writes the new document to the verification case record base directory. A content-validation failure of the submitted body returns a non-raising ValidateResult (valid=False, a single errors[].message capped at 300 chars as the generic validate tool caps it, feat-110) instead of raising AssertionError/pydantic.ValidationError (ADR f14f125e-eaad-4f4f-a6fd-3c931bed726e, GitHub issue #204 -- case 5 of the ADR 519d1206 non-raising-structured-result workaround chain); nothing is written in that case. Returns the newly created document's frontmatter only (no body); use the corresponding get_vcr tool to fetch the full document afterward.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.36.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does well: it discloses id generation, filename derivation from the H1 title, that nothing is written on validation failure, and the non-raising `ValidateResult` (`valid=False`, `errors[].message` capped at 300 chars) instead of `AssertionError`/`pydantic.ValidationError`. It does not cover other operational traits such as permission/auth requirements, behavior on filename collisions, or I/O error surfaces, so it is strong rather than complete.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core behavior is front-loaded in sentence one, but the middle sentence is bloated with internal identifiers ('feat-110', ADR UUIDs, 'GitHub issue #204 -- case 5 of the ADR 519d1206 non-raising-structured-result workaround chain') that an invoking agent cannot act on. Trimming those would preserve all usable meaning in roughly half the tokens.

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 values need not be spelled out, yet the description still adds value by stating the return is frontmatter-only with no body and pointing to get_vcr for the full document. Given a single-parameter mutation tool with no annotations, this covers calling behavior adequately; the remaining gap is failure handling outside the validation path.

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?

Schema description coverage is 0%, so the description must compensate for the single bare `content` string. It does: 'submitted body-only content' clarifies frontmatter must be excluded, and it explains that the H1 title inside the content drives the generated filename. It stops short of stating whether an H1 is mandatory or what format/encoding is expected.

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?

States a specific verb and resource ('Create a new verification case record') and enumerates the concrete side effects: fresh id assignment, filename derivation from the H1 title, validation, and write to the VCR base directory. An agent can distinguish this from sibling create_* tools and from get_vcr/parse_vcr/list_vcr without opening anything else.

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?

Explicitly names the follow-up alternative: 'use the corresponding `get_vcr` tool to fetch the full document afterward,' which resolves the natural next-step question after a write. However, it never states prerequisites or when NOT to use this (e.g., when to prefer parse_vcr or how a failed validation should be handled by the caller beyond noting nothing was written).

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