Skip to main content
Glama

Create Scenario

create_scenario

Create a scenario in a project — saving costs nothing and starts nothing, so hand the user the dashboard link and let them launch it. The save is refused for a loadEngineId list_engines doesn't offer, a stage shorter than the minimum, or more bots or populations than the account allows, and the refusal names the limit. The summary's launchBlockers are reasons the user could not launch it right now; they never stop the save, so tell the user about a blocker instead of rewriting the scenario to avoid it. The 'load-test-scenarios' topic covers what the stages and ramps actually do.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesThe scenario name.
projectIdYes
populationsYesThe Populations, in order. Each needs a name, the scriptId of a script in this project, and stages — { target, duration, ramp } segments that run for duration milliseconds and reach target bots by the end, each starting from where the previous stage left off. Optional per population: id (send back the id get_scenario reported to keep a population's identity), loadEngineId (an id from list_engines; defaults to the account's default region), iterations, iterationsPerUser, aggressionMultiplier, and playbackOptions with connectionBps (bits per second), hostnameOverrides, and variableOverrides. Read get_documentation topic 'load-test-scenarios' for what stages and ramps do; list_engines carries the account's stage bounds and bot caps.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

The description reveals important behavioral traits beyond the annotations: saving has no cost and starts nothing, refusals occur for specific invalid inputs, refusal messages name the limit, and launchBlockers do not prevent saving. Since annotations are all false/uninformative, the description carries the burden and does so richly.

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 carry a large amount of actionable information with no filler. The most important side-effect statement is front-loaded, followed by validation semantics and user-handling guidance. Every sentence earns its place.

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?

For a create tool with no output schema, the description covers side effects, validation failures, the response summary's launchBlockers, and a pointer to relevant documentation. However, it does not explain how to source or validate projectId, nor name the exact response field for the dashboard link, leaving minor gaps an agent must infer.

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?

The schema already documents populations and stages in detail, but top-level projectId has no description and name only has a trivial one. The description adds meaningful operational constraints: loadEngineId must come from list_engines, stages must meet minimum duration, and bot/population counts are subject to account limits. This compensates for schema gaps, though it does not enumerate every parameter.

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?

The description opens with 'Create a scenario in a project,' a specific verb and resource that clearly identifies the tool's function. The resource 'scenario' is distinct from sibling create_* tools, so an agent can select it without opening the schema. The added context about saving not starting anything further sharpens the purpose.

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?

The description gives clear context: saving is cheap and inert, so the agent should hand the user the dashboard link and let the user launch the scenario. It also instructs how to handle launch blockers. However, it does not explicitly name alternative tools or state when *not* to use this tool, so it stops short of full exclusion guidance.

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.