Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_experiment_save

Idempotent

Save an experiment record and bind it to a confirmed project foundation without executing it.

Instructions

Save an experiment and bind its confirmed project foundation; does not execute it.

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": {
      "requestId": "<requestId>",
      "projectId": "<projectId>",
      "expectedRevision": "<expectedRevision>",
      "record": "<record>"
    },
    "name": "rws_experiment_save"
  }
}

Input Schema

NameRequiredDescriptionDefault
recordYesFor an existing id, provide only fields to change; omitted fields are preserved. A new id still requires a complete valid record.
projectIdYes
requestIdYes
expectedRevisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.4.2
    • changedInput schema / properties / record / anyOf
      Previous value: -[
      -  {
      -    "required": [
      -      "id"
      -    ]
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "config": {
      -        "additionalProperties": true,
      -        "type": "object"
      -      },
      -      "foundationRevision": {
      -        "minimum": 1,
      -        "type": "integer"
      -      },
      -      "id": {
      -        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      -        "type": "string"
      -      },
      -      "protocolRef": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "id": {
      -            "type": "string"
      -          },
      -          "projectId": {
      -            "type": "string"
      -          },
      -          "type": {
      -            "enum": [
      -              "research",
      -              "experiment",
      -              "code",
      -              "run",
      -              "artifact",
      -              "protocol",
      -              "dataset",
      -              "evaluation",
      -              "comparison",
      -              "analysis",
      -              "report",
      -              "conversation",
      -              "proposal",
      -              "usage",
      -              "spec",
      -              "amendment"
      -            ],
      -            "type": "string"
      -          },
      -          "version": {
      -            "minimum": 1,
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "projectId",
      -          "type",
      -          "id"
      -        ],
      -        "type": "object"
      -      },
      -      "researchRef": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "id": {
      -            "type": "string"
      -          },
      -          "projectId": {
      -            "type": "string"
      -          },
      -          "type": {
      -            "enum": [
      -              "research",
      -              "experiment",
      -              "code",
      -              "run",
      -              "artifact",
      -              "protocol",
      -              "dataset",
      -              "evaluation",
      -              "comparison",
      -              "analysis",
      -              "report",
      -              "conversation",
      -              "proposal",
      -              "usage",
      -              "spec",
      -              "amendment"
      -            ],
      -            "type": "string"
      -          },
      -          "version": {
      -            "minimum": 1,
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "projectId",
      -          "type",
      -          "id"
      -        ],
      -        "type": "object"
      -      },
      -      "status": {
      -        "enum": [
      -          "planned",
      -          "running",
      -          "completed",
      -          "failed",
      -          "partial"
      -        ]
      -      },
      -      "title": {
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "title",
      -      "researchRef"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "required": [
      +      "id"
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "config": {
      +        "additionalProperties": true,
      +        "type": "object"
      +      },
      +      "foundationRevision": {
      +        "minimum": 1,
      +        "type": "integer"
      +      },
      +      "id": {
      +        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      +        "type": "string"
      +      },
      +      "protocolRef": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": "string"
      +          },
      +          "projectId": {
      +            "type": "string"
      +          },
      +          "type": {
      +            "enum": [
      +              "research",
      +              "experiment",
      +              "code",
      +              "run",
      +              "artifact",
      +              "protocol",
      +              "dataset",
      +              "evaluation",
      +              "comparison",
      +              "analysis",
      +              "report",
      +              "conversation",
      +              "proposal",
      +              "usage",
      +              "spec",
      +              "amendment",
      +              "server",
      +              "repository",
      +              "environment",
      +              "operation"
      +            ],
      +            "type": "string"
      +          },
      +          "version": {
      +            "minimum": 1,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "projectId",
      +          "type",
      +          "id"
      +        ],
      +        "type": "object"
      +      },
      +      "researchRef": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": "string"
      +          },
      +          "projectId": {
      +            "type": "string"
      +          },
      +          "type": {
      +            "enum": [
      +              "research",
      +              "experiment",
      +              "code",
      +              "run",
      +              "artifact",
      +              "protocol",
      +              "dataset",
      +              "evaluation",
      +              "comparison",
      +              "analysis",
      +              "report",
      +              "conversation",
      +              "proposal",
      +              "usage",
      +              "spec",
      +              "amendment",
      +              "server",
      +              "repository",
      +              "environment",
      +              "operation"
      +            ],
      +            "type": "string"
      +          },
      +          "version": {
      +            "minimum": 1,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "projectId",
      +          "type",
      +          "id"
      +        ],
      +        "type": "object"
      +      },
      +      "status": {
      +        "enum": [
      +          "planned",
      +          "running",
      +          "completed",
      +          "failed",
      +          "partial",
      +          "unknown"
      +        ]
      +      },
      +      "title": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "title",
      +      "researchRef"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / record / properties / protocolRef / properties / type / enum
      Previous value: -[
      -  "research",
      -  "experiment",
      -  "code",
      -  "run",
      -  "artifact",
      -  "protocol",
      -  "dataset",
      -  "evaluation",
      -  "comparison",
      -  "analysis",
      -  "report",
      -  "conversation",
      -  "proposal",
      -  "usage",
      -  "spec",
      -  "amendment"
      -]New value: +[
      +  "research",
      +  "experiment",
      +  "code",
      +  "run",
      +  "artifact",
      +  "protocol",
      +  "dataset",
      +  "evaluation",
      +  "comparison",
      +  "analysis",
      +  "report",
      +  "conversation",
      +  "proposal",
      +  "usage",
      +  "spec",
      +  "amendment",
      +  "server",
      +  "repository",
      +  "environment",
      +  "operation"
      +]
    • changedInput schema / properties / record / properties / researchRef / properties / type / enum
      Previous value: -[
      -  "research",
      -  "experiment",
      -  "code",
      -  "run",
      -  "artifact",
      -  "protocol",
      -  "dataset",
      -  "evaluation",
      -  "comparison",
      -  "analysis",
      -  "report",
      -  "conversation",
      -  "proposal",
      -  "usage",
      -  "spec",
      -  "amendment"
      -]New value: +[
      +  "research",
      +  "experiment",
      +  "code",
      +  "run",
      +  "artifact",
      +  "protocol",
      +  "dataset",
      +  "evaluation",
      +  "comparison",
      +  "analysis",
      +  "report",
      +  "conversation",
      +  "proposal",
      +  "usage",
      +  "spec",
      +  "amendment",
      +  "server",
      +  "repository",
      +  "environment",
      +  "operation"
      +]
    • changedInput schema / properties / record / properties / status / enum
      Previous value: -[
      -  "planned",
      -  "running",
      -  "completed",
      -  "failed",
      -  "partial"
      -]New value: +[
      +  "planned",
      +  "running",
      +  "completed",
      +  "failed",
      +  "partial",
      +  "unknown"
      +]
  2. First observedv0.3.3

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare that this is a non-read-only, idempotent, non-destructive write. The description adds meaningful context beyond that: it binds a confirmed project foundation and does not execute the experiment. It does not cover return behavior or concurrency, but it adds useful behavioral constraints.

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?

The description is a single front-loaded sentence with no wasted words. It communicates the core action and the most important boundary immediately.

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

Completeness2/5

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

For a mutation tool with four required parameters, nested objects, no output schema, and low schema description coverage, the description is too sparse. It does not explain required fields, revision handling, idempotency expectations, or what a successful save returns.

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 only 25%, so the description should compensate but largely does not. It implies that the record is an experiment and that a confirmed foundation is involved, but it does not explain requestId, projectId, expectedRevision, or the nested record fields.

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?

The description states a specific verb and resource: saving an experiment. It also clarifies that it binds a confirmed project foundation and does not execute it, which distinguishes it from execution-oriented tools. However, it does not explicitly differentiate itself from sibling save/register tools.

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 phrase "does not execute it" implies a usage boundary, and "confirmed project foundation" hints at a prerequisite. But the description does not explicitly say when to use this tool versus alternatives like rws_run_register or other save tools.

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