Skip to main content
Glama

Update an experiment

update_experiment
Idempotent

[writes flayr data · write scope] Changes an experiment's fields (e.g. status "running" / "done", endAt, notes). Only the fields you pass change. (Wraps PATCH /api/v2/experiments/{id}.)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "update_experiment"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
nameNo
endAtNo
notesNo
statusNo
startAtNo
variantsNo
compareKeyNo
hypothesisNo
primaryMetricNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / primaryMetric / enum
      Previous value: -[
      -  "impressions",
      -  "views",
      -  "engagement",
      -  "engagementRate",
      -  "clicks"
      -]New value: +[
      +  "impressions",
      +  "views",
      +  "engagement",
      +  "engagementRate",
      +  "clicks",
      +  "averageViewPercentage"
      +]
  2. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Adds real information beyond annotations: the required `write` scope, the fact that it writes flayr data, the PATCH partial-update guarantee ('Only the fields you pass change'), and the wrapped endpoint. It does not describe what happens to variants/compareKey when changed mid-run or what the response returns, which are meaningful gaps for a mutation tool.

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

Conciseness4/5

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

Front-loaded scope tag, then two tight sentences, then the endpoint in parentheses. Nothing is redundant, though the endpoint reference is only marginally useful to an agent.

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

Completeness3/5

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

For a 10-parameter mutation tool with no output schema and zero schema description coverage, the definition covers partial-update semantics and auth scope but leaves most fields and the return value unexplained. Adequate to call it correctly, not enough to call it well.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 10 parameters, so the description must carry the semantic load, but it only names three (status, endAt, notes) and adds no meaning for name, startAt, variants, compareKey, hypothesis, or primaryMetric. The enum values for status and primaryMetric are never explained, and side effects of mutating variants on a running experiment are unstated.

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 ('Changes an experiment's fields') and gives concrete examples (status "running"/"done", endAt, notes), plus the underlying PATCH endpoint. This clearly separates it from create_experiment, get_experiment, and delete_experiment, though it never explicitly names siblings.

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 when to use it (editing existing experiment fields, partial updates), but offers no explicit when-not guidance or routing against close_experiment_round / start_experiment_round, which are the nearest ambiguous alternatives for changing status.

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.

Resources