Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_run_register

Idempotent

Record an actual run and its status in a research workflow without launching the program; use it to register or update run metadata while preserving immutable producer bindings.

Instructions

Record an actual run and status. Registration never launches a program; producer bindings are immutable.

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_run_register"
  }
}

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. Changed7 schema fields changedv0.4.2
    • changedInput schema / properties / record / anyOf
      Previous value: -[
      -  {
      -    "required": [
      -      "id"
      -    ]
      -  },
      -  {
      -    "additionalProperties": false,
      -    "anyOf": [
      -      {
      -        "required": [
      -          "codeRef"
      -        ]
      -      },
      -      {
      -        "properties": {
      -          "manual": {
      -            "const": true
      -          }
      -        },
      -        "required": [
      -          "manual"
      -        ]
      -      }
      -    ],
      -    "properties": {
      -      "codeRef": {
      -        "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"
      -      },
      -      "config": {
      -        "additionalProperties": true,
      -        "type": "object"
      -      },
      -      "experimentRef": {
      -        "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"
      -      },
      -      "id": {
      -        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      -        "type": "string"
      -      },
      -      "inputRefs": {
      -        "items": {
      -          "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"
      -        },
      -        "type": "array"
      -      },
      -      "kind": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "manual": {
      -        "type": "boolean"
      -      },
      -      "notes": {
      -        "type": "string"
      -      },
      -      "purpose": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "sampleSelection": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "datasetRef": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "id": {
      -                "type": "string"
      -              },
      -              "projectId": {
      -                "type": "string"
      -              },
      -              "type": {
      -                "enum": [
      -                  "dataset"
      -                ],
      -                "type": "string"
      -              },
      -              "version": {
      -                "minimum": 1,
      -                "type": "integer"
      -              }
      -            },
      -            "required": [
      -              "projectId",
      -              "type",
      -              "id"
      -            ],
      -            "type": "object"
      -          },
      -          "sampleIds": {
      -            "items": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "type": "array",
      -            "uniqueItems": true
      -          }
      -        },
      -        "required": [
      -          "sampleIds"
      -        ],
      -        "type": "object"
      -      },
      -      "source": {
      -        "oneOf": [
      -          {
      -            "minLength": 1,
      -            "type": "string"
      -          },
      -          {
      -            "additionalProperties": true,
      -            "minProperties": 1,
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "status": {
      -        "enum": [
      -          "planned",
      -          "running",
      -          "completed",
      -          "failed",
      -          "partial"
      -        ]
      -      },
      -      "title": {
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "title"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "required": [
      +      "id"
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "anyOf": [
      +      {
      +        "required": [
      +          "codeRef"
      +        ]
      +      },
      +      {
      +        "properties": {
      +          "manual": {
      +            "const": true
      +          }
      +        },
      +        "required": [
      +          "manual"
      +        ]
      +      }
      +    ],
      +    "properties": {
      +      "codeRef": {
      +        "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"
      +      },
      +      "config": {
      +        "additionalProperties": true,
      +        "type": "object"
      +      },
      +      "environmentRef": {
      +        "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",
      +          "version"
      +        ],
      +        "type": "object"
      +      },
      +      "experimentRef": {
      +        "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"
      +      },
      +      "id": {
      +        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      +        "type": "string"
      +      },
      +      "inputRefs": {
      +        "items": {
      +          "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"
      +        },
      +        "type": "array"
      +      },
      +      "kind": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "manual": {
      +        "type": "boolean"
      +      },
      +      "notes": {
      +        "type": "string"
      +      },
      +      "purpose": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "repositoryRef": {
      +        "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",
      +          "version"
      +        ],
      +        "type": "object"
      +      },
      +      "sampleSelection": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "datasetRef": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "id": {
      +                "type": "string"
      +              },
      +              "projectId": {
      +                "type": "string"
      +              },
      +              "type": {
      +                "enum": [
      +                  "dataset"
      +                ],
      +                "type": "string"
      +              },
      +              "version": {
      +                "minimum": 1,
      +                "type": "integer"
      +              }
      +            },
      +            "required": [
      +              "projectId",
      +              "type",
      +              "id"
      +            ],
      +            "type": "object"
      +          },
      +          "sampleIds": {
      +            "items": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "type": "array",
      +            "uniqueItems": true
      +          }
      +        },
      +        "required": [
      +          "sampleIds"
      +        ],
      +        "type": "object"
      +      },
      +      "source": {
      +        "oneOf": [
      +          {
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          {
      +            "additionalProperties": true,
      +            "minProperties": 1,
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "status": {
      +        "enum": [
      +          "planned",
      +          "running",
      +          "completed",
      +          "failed",
      +          "partial",
      +          "unknown"
      +        ]
      +      },
      +      "title": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "title"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / record / properties / codeRef / 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"
      +]
    • addedInput schema / properties / record / properties / environmentRef
      Added value: +{
      +  "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",
      +    "version"
      +  ],
      +  "type": "object"
      +}
    • changedInput schema / properties / record / properties / experimentRef / 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 / inputRefs / items / 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"
      +]
    • addedInput schema / properties / record / properties / repositoryRef
      Added value: +{
      +  "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",
      +    "version"
      +  ],
      +  "type": "object"
      +}
    • 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 non-readonly, idempotent, non-destructive behavior. The description adds useful context beyond annotations by stating that registration never launches a program and that producer bindings are immutable, which materially affects how an agent should understand the operation.

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?

Two short sentences, front-loaded with the core purpose and immediately followed by an important constraint. There is no wasted text.

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?

This is a complex mutation tool with four required parameters, nested objects, low schema description coverage, and no output schema. The description is too sparse to explain critical semantics such as expectedRevision concurrency behavior, requestId idempotency, or how partial record updates are handled beyond what is buried in the schema.

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%, and the description does not explain the required parameters requestId, projectId, expectedRevision, or the structure of record. The schema itself includes a record-level note about partial updates, but the tool description does not compensate for the low overall schema coverage.

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: 'Record an actual run and status.' It is clear what the tool does, though it does not explicitly differentiate itself from sibling registration tools such as rws_experiment_save or rws_protocol_register.

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?

Usage is implied by 'Record an actual run and status,' but the description gives no explicit when-to-use or when-not-to-use guidance. It clarifies that registration does not launch a program, but does not name alternatives or conditions for choosing them.

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