Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_comparison_save

Idempotent

Save exact comparison inputs and fixed/varying conditions for a project without relocating their original producers; update an existing comparison by ID or create a full record.

Instructions

Save exact comparison inputs and fixed/varying conditions without moving their original producers.

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_comparison_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. Changed2 schema fields changedv0.5.1
    • changedInput schema / properties / record / anyOf
      Previous value: -[
      -  {
      -    "required": [
      -      "id"
      -    ]
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "description": {
      -        "type": "string"
      -      },
      -      "fixedConditions": {
      -        "additionalProperties": true,
      -        "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"
      -      },
      -      "title": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "varyingConditions": {
      -        "oneOf": [
      -          {
      -            "items": {
      -              "type": "string"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "additionalProperties": true,
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "viewSpec": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "axis": {
      -            "type": "string"
      -          },
      -          "filters": {
      -            "type": "object"
      -          },
      -          "mode": {
      -            "enum": [
      -              "single",
      -              "multi"
      -            ]
      -          },
      -          "observation": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "label": {
      -                "type": "string"
      -              },
      -              "step": {
      -                "minimum": 0,
      -                "type": "number"
      -              },
      -              "time": {
      -                "type": "number"
      -              }
      -            },
      -            "type": "object"
      -          },
      -          "repeats": {
      -            "enum": [
      -              "all",
      -              "latest"
      -            ]
      -          },
      -          "sampleIds": {
      -            "items": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "type": "array",
      -            "uniqueItems": true
      -          },
      -          "selectedValues": {
      -            "type": "array"
      -          },
      -          "semantics": {
      -            "items": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "type": "array",
      -            "uniqueItems": true
      -          }
      -        },
      -        "required": [
      -          "mode"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "title",
      -      "inputRefs",
      -      "fixedConditions",
      -      "varyingConditions"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "required": [
      +      "id"
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "description": {
      +        "type": "string"
      +      },
      +      "fixedConditions": {
      +        "additionalProperties": true,
      +        "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"
      +      },
      +      "title": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "varyingConditions": {
      +        "oneOf": [
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "additionalProperties": true,
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "viewSpec": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "axis": {
      +            "type": "string"
      +          },
      +          "filters": {
      +            "type": "object"
      +          },
      +          "methodGroups": {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "artifactRefs": {
      +                  "items": {
      +                    "additionalProperties": false,
      +                    "properties": {
      +                      "id": {
      +                        "type": "string"
      +                      },
      +                      "projectId": {
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "artifact"
      +                        ],
      +                        "type": "string"
      +                      },
      +                      "version": {
      +                        "minimum": 1,
      +                        "type": "integer"
      +                      }
      +                    },
      +                    "required": [
      +                      "projectId",
      +                      "type",
      +                      "id",
      +                      "version"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "minItems": 1,
      +                  "type": "array"
      +                },
      +                "id": {
      +                  "minLength": 1,
      +                  "type": "string"
      +                },
      +                "label": {
      +                  "minLength": 1,
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "id",
      +                "label",
      +                "artifactRefs"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "mode": {
      +            "enum": [
      +              "single",
      +              "multi"
      +            ]
      +          },
      +          "observation": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "label": {
      +                "type": "string"
      +              },
      +              "step": {
      +                "minimum": 0,
      +                "type": "number"
      +              },
      +              "time": {
      +                "type": "number"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "repeats": {
      +            "enum": [
      +              "all",
      +              "latest"
      +            ]
      +          },
      +          "sampleIds": {
      +            "items": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "type": "array",
      +            "uniqueItems": true
      +          },
      +          "selectedValues": {
      +            "type": "array"
      +          },
      +          "semantics": {
      +            "items": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "type": "array",
      +            "uniqueItems": true
      +          }
      +        },
      +        "required": [
      +          "mode"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "title",
      +      "inputRefs",
      +      "fixedConditions",
      +      "varyingConditions"
      +    ],
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / record / properties / viewSpec / properties / methodGroups
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "artifactRefs": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "id": {
      +              "type": "string"
      +            },
      +            "projectId": {
      +              "type": "string"
      +            },
      +            "type": {
      +              "enum": [
      +                "artifact"
      +              ],
      +              "type": "string"
      +            },
      +            "version": {
      +              "minimum": 1,
      +              "type": "integer"
      +            }
      +          },
      +          "required": [
      +            "projectId",
      +            "type",
      +            "id",
      +            "version"
      +          ],
      +          "type": "object"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "id": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "label": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "label",
      +      "artifactRefs"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  2. Changed2 schema fields changedv0.4.2
    • changedInput schema / properties / record / anyOf
      Previous value: -[
      -  {
      -    "required": [
      -      "id"
      -    ]
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "description": {
      -        "type": "string"
      -      },
      -      "fixedConditions": {
      -        "additionalProperties": true,
      -        "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"
      -      },
      -      "title": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "varyingConditions": {
      -        "oneOf": [
      -          {
      -            "items": {
      -              "type": "string"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "additionalProperties": true,
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "viewSpec": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "axis": {
      -            "type": "string"
      -          },
      -          "filters": {
      -            "type": "object"
      -          },
      -          "mode": {
      -            "enum": [
      -              "single",
      -              "multi"
      -            ]
      -          },
      -          "observation": {
      -            "additionalProperties": false,
      -            "properties": {
      -              "label": {
      -                "type": "string"
      -              },
      -              "step": {
      -                "minimum": 0,
      -                "type": "number"
      -              },
      -              "time": {
      -                "type": "number"
      -              }
      -            },
      -            "type": "object"
      -          },
      -          "repeats": {
      -            "enum": [
      -              "all",
      -              "latest"
      -            ]
      -          },
      -          "sampleIds": {
      -            "items": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "type": "array",
      -            "uniqueItems": true
      -          },
      -          "selectedValues": {
      -            "type": "array"
      -          },
      -          "semantics": {
      -            "items": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "type": "array",
      -            "uniqueItems": true
      -          }
      -        },
      -        "required": [
      -          "mode"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "title",
      -      "inputRefs",
      -      "fixedConditions",
      -      "varyingConditions"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "required": [
      +      "id"
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "description": {
      +        "type": "string"
      +      },
      +      "fixedConditions": {
      +        "additionalProperties": true,
      +        "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"
      +      },
      +      "title": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "varyingConditions": {
      +        "oneOf": [
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "additionalProperties": true,
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "viewSpec": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "axis": {
      +            "type": "string"
      +          },
      +          "filters": {
      +            "type": "object"
      +          },
      +          "mode": {
      +            "enum": [
      +              "single",
      +              "multi"
      +            ]
      +          },
      +          "observation": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "label": {
      +                "type": "string"
      +              },
      +              "step": {
      +                "minimum": 0,
      +                "type": "number"
      +              },
      +              "time": {
      +                "type": "number"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "repeats": {
      +            "enum": [
      +              "all",
      +              "latest"
      +            ]
      +          },
      +          "sampleIds": {
      +            "items": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "type": "array",
      +            "uniqueItems": true
      +          },
      +          "selectedValues": {
      +            "type": "array"
      +          },
      +          "semantics": {
      +            "items": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "type": "array",
      +            "uniqueItems": true
      +          }
      +        },
      +        "required": [
      +          "mode"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "title",
      +      "inputRefs",
      +      "fixedConditions",
      +      "varyingConditions"
      +    ],
      +    "type": "object"
      +  }
      +]
    • 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"
      +]
  3. First observedv0.3.3

TDQS

C2.9/5.0
Behavior3/5

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

The annotations already declare that this is non-read-only, idempotent, and non-destructive. The description adds a useful specific guarantee that original producers are not moved, but it does not explain create-versus-update behavior, concurrency expectations around expectedRevision, or other side effects of the save operation.

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?

The description is a single front-loaded sentence with no filler, and the key scope constraint is stated clearly. Its brevity is appropriate for a concise definition, though it leaves substantial complexity to the schema.

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 nested save/upsert tool with four required parameters, 25% schema description coverage, and no output schema. A one-sentence description does not cover important operational context such as create versus update behavior, optimistic concurrency via expectedRevision, project scoping, or what the 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% and the description only maps to the record contents, namely comparison inputs and fixed/varying conditions. It does not add meaning for requestId, projectId, or expectedRevision, nor does it explain how id presence changes create-versus-update behavior beyond what the record schema itself says.

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, 'Save', and a specific resource, 'comparison inputs and fixed/varying conditions', plus the scope 'without moving their original producers'. It is clear what the tool does, but it does not explicitly distinguish this save tool from sibling save/register tools such as rws_analysis_save or rws_report_create_revision.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance, and no named alternatives among the many save/register sibling tools. The only usage signal is the implied need to save comparison inputs and conditions; prerequisites such as new-versus-existing record behavior and expectedRevision handling are left to the schema.

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