Skip to main content
Glama

tarn_scaffold

Generate a minimal .tarn.yaml test skeleton from OpenAPI operation ID, raw curl command, explicit method+URL, or recorded fixture. Outputs YAML with metadata and optional file write.

Instructions

Generate a minimal .tarn.yaml skeleton from one of four input modes (OpenAPI operation id, raw curl, method+url, or a recorded fixture). Returns the rendered YAML plus structured metadata (TODOs, inferred request, validation). Optional out writes the file to disk. Equivalent to: tarn scaffold --from-openapi / --from-curl / --method+--url / --from-recorded.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
curlNoPayload for mode=curl. Provide either `command` (inline) or `file` (path to read).
cwdNoAbsolute path to the project root. Defaults to the workspace root captured during MCP `initialize`, or the server process's current directory.
explicitNoPayload for mode=explicit.
forceNoAllow overwriting an existing `out` path.
formatNoWhen `out` is set, write YAML (default) or the JSON metadata block.
modeYesInput mode. Must match the payload object provided.
nameNoOverride the inferred top-level `name:` field.
openapiNoPayload for mode=openapi.
outNoWrite the scaffold to this path (relative paths resolve against `cwd`). Refuses to overwrite unless `force=true`.
recordedNoPayload for mode=recorded.
Behavior3/5

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

No annotations are provided, so the description carries full burden. It mentions output includes 'rendered YAML plus structured metadata' and that `out` writes to disk with `force` to overwrite, but does not discuss authentication, rate limits, or side effects beyond file writing.

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?

Description is three sentences, front-loaded with the main action and modes. Every sentence adds value with no redundancy.

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?

Given 10 parameters with nested objects and no output schema, the description covers the main modes and output structure. It mentions the CLI equivalent for clarity, missing only details on error handling or validation.

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?

Input schema has 100% description coverage, so baseline is 3. Description adds minimal extra meaning beyond listing modes and the `out` behavior, but does not significantly enhance understanding of parameters.

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?

Description states 'Generate a minimal `.tarn.yaml` skeleton from one of four input modes' with specific modes listed, clearly distinguishing it from sibling tools which have different purposes.

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 description implies usage for scaffolding but does not explicitly provide when-to-use or when-not-to-use scenarios or alternatives. It relies on the context of being the only scaffold tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/NazarKalytiuk/tarn'

If you have feedback or need assistance with the MCP directory API, please join our Discord server