Skip to main content
Glama

Load a scenario

twin_load_scenario
DestructiveIdempotent

Load a named or custom YAML scenario into a local API twin to set up test state, faults, auth, and timeline, returning the updated status.

Instructions

Throw away the current world and build one from a scenario: a ready-made one by name (see twin_list_scenarios), or your own YAML (seed, startTime, world, faults, auth, timeline). Give one of the two. A scenario that doesn't load leaves the twin as it was. twin_reset comes back to its start. Answers with the new status.

Input Schema

NameRequiredDescriptionDefault
nameNoA ready-made scenario's name, like flaky-apis
yamlNoA whole scenario as YAML, instead of a name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.5.3
    • addedInput schema / properties / name / description
      Added value: +"A ready-made scenario's name, like flaky-apis"
    • addedInput schema / properties / yaml / description
      Added value: +"A whole scenario as YAML, instead of a name"
  2. First observedv0.5.2

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and readOnlyHint=false, so safety is covered; the description still adds the valuable failure-mode guarantee ('a scenario that doesn't load leaves the twin as it was') and states the response is the new status. It does not discuss authorization or scenario size limits, keeping it short of a 5.

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?

Three dense sentences with the destructive scope front-loaded, no filler, and every clause carrying a distinct fact (source modes, exclusivity, atomicity, undo path, return value).

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 2-param, no-output-schema, fully-annotated tool, the description covers source selection, failure behavior, undo, and what is returned. Nothing an agent needs before invoking it is missing.

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 coverage is 100%, but the description still adds meaning beyond it: the YAML shape is summarized (seed, startTime, world, faults, auth, timeline) and the exclusivity constraint between name and yaml is stated, which the schema's required-count of zero does not convey.

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 destructive verb ('throw away the current world and build one') plus the two source modes, and names siblings (twin_list_scenarios for names, twin_reset for reverting). An agent can distinguish it from every other twin_* tool immediately.

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

Usage Guidelines5/5

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

'Give one of the two' explicitly states the mutual-exclusion rule, and it routes to twin_list_scenarios to discover names and to twin_reset as the undo path. Both when-to-use and the alternative course of action are spelled out.

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