Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_spec_save

Idempotent

Save a draft or ready revision of a method-level contract before implementation, preserving omitted fields on updates. Implementations can then pin the exact ready revision.

Instructions

Define a method-level contract before implementation. Saves a new draft or ready revision; implementations pin an exact ready revision. Cases/configurations belong to runs, not method contracts.

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_spec_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": {
      -      "acceptanceChecks": {
      -        "items": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "description": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "id": {
      -              "minLength": 1,
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "id",
      -            "description"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      "capabilities": {
      -        "items": {
      -          "minLength": 1,
      -          "type": "string"
      -        },
      -        "type": "array",
      -        "uniqueItems": true
      -      },
      -      "configSchema": {
      -        "type": "object"
      -      },
      -      "dependencies": {
      -        "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"
      -      },
      -      "id": {
      -        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      -        "type": "string"
      -      },
      -      "inputs": {
      -        "items": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "description": {
      -              "type": "string"
      -            },
      -            "kind": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "multiple": {
      -              "type": "boolean"
      -            },
      -            "name": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "required": {
      -              "type": "boolean"
      -            },
      -            "semantic": {
      -              "minLength": 1,
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "name",
      -            "kind"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      "kind": {
      -        "enum": [
      -          "inference",
      -          "evaluation",
      -          "analysis",
      -          "report"
      -        ]
      -      },
      -      "outputs": {
      -        "items": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "description": {
      -              "type": "string"
      -            },
      -            "kind": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "multiple": {
      -              "type": "boolean"
      -            },
      -            "name": {
      -              "minLength": 1,
      -              "type": "string"
      -            },
      -            "required": {
      -              "type": "boolean"
      -            },
      -            "semantic": {
      -              "minLength": 1,
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "name",
      -            "kind"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      "purpose": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "schemaVersion": {
      -        "const": 1,
      -        "type": "integer"
      -      },
      -      "status": {
      -        "enum": [
      -          "draft",
      -          "ready"
      -        ]
      -      },
      -      "title": {
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "title",
      -      "schemaVersion",
      -      "kind",
      -      "status",
      -      "purpose",
      -      "inputs",
      -      "outputs",
      -      "configSchema",
      -      "dependencies",
      -      "acceptanceChecks",
      -      "capabilities"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "required": [
      +      "id"
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "acceptanceChecks": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "description": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "id": {
      +              "minLength": 1,
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "description"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "capabilities": {
      +        "items": {
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "type": "array",
      +        "uniqueItems": true
      +      },
      +      "configSchema": {
      +        "type": "object"
      +      },
      +      "dependencies": {
      +        "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"
      +      },
      +      "id": {
      +        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      +        "type": "string"
      +      },
      +      "inputs": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "description": {
      +              "type": "string"
      +            },
      +            "kind": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "multiple": {
      +              "type": "boolean"
      +            },
      +            "name": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "required": {
      +              "type": "boolean"
      +            },
      +            "semantic": {
      +              "minLength": 1,
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "kind"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "kind": {
      +        "enum": [
      +          "training",
      +          "inference",
      +          "evaluation",
      +          "analysis",
      +          "report"
      +        ]
      +      },
      +      "outputs": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "description": {
      +              "type": "string"
      +            },
      +            "kind": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "multiple": {
      +              "type": "boolean"
      +            },
      +            "name": {
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "required": {
      +              "type": "boolean"
      +            },
      +            "semantic": {
      +              "minLength": 1,
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "kind"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "processMetrics": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "axis": {
      +              "enum": [
      +                "step",
      +                "epoch",
      +                "time"
      +              ]
      +            },
      +            "direction": {
      +              "enum": [
      +                "higher",
      +                "lower",
      +                "none"
      +              ]
      +            },
      +            "id": {
      +              "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$",
      +              "type": "string"
      +            },
      +            "name": {
      +              "maxLength": 160,
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            "protocolRef": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "id": {
      +                  "type": "string"
      +                },
      +                "projectId": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "enum": [
      +                    "protocol"
      +                  ],
      +                  "type": "string"
      +                },
      +                "version": {
      +                  "minimum": 1,
      +                  "type": "integer"
      +                }
      +              },
      +              "required": [
      +                "projectId",
      +                "type",
      +                "id",
      +                "version"
      +              ],
      +              "type": "object"
      +            },
      +            "scope": {
      +              "enum": [
      +                "run",
      +                "sample"
      +              ]
      +            },
      +            "splits": {
      +              "items": {
      +                "maxLength": 80,
      +                "minLength": 1,
      +                "type": "string"
      +              },
      +              "maxItems": 32,
      +              "type": "array",
      +              "uniqueItems": true
      +            },
      +            "unit": {
      +              "maxLength": 64,
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "unit",
      +            "axis",
      +            "scope"
      +          ],
      +          "type": "object"
      +        },
      +        "maxItems": 64,
      +        "type": "array"
      +      },
      +      "purpose": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "schemaVersion": {
      +        "const": 1,
      +        "type": "integer"
      +      },
      +      "status": {
      +        "enum": [
      +          "draft",
      +          "ready"
      +        ]
      +      },
      +      "title": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "title",
      +      "schemaVersion",
      +      "kind",
      +      "status",
      +      "purpose",
      +      "inputs",
      +      "outputs",
      +      "configSchema",
      +      "dependencies",
      +      "acceptanceChecks",
      +      "capabilities"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / record / properties / dependencies / 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"
      +]
    • changedInput schema / properties / record / properties / kind / enum
      Previous value: -[
      -  "inference",
      -  "evaluation",
      -  "analysis",
      -  "report"
      -]New value: +[
      +  "training",
      +  "inference",
      +  "evaluation",
      +  "analysis",
      +  "report"
      +]
    • addedInput schema / properties / record / properties / processMetrics
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "axis": {
      +        "enum": [
      +          "step",
      +          "epoch",
      +          "time"
      +        ]
      +      },
      +      "direction": {
      +        "enum": [
      +          "higher",
      +          "lower",
      +          "none"
      +        ]
      +      },
      +      "id": {
      +        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$",
      +        "type": "string"
      +      },
      +      "name": {
      +        "maxLength": 160,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "protocolRef": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": "string"
      +          },
      +          "projectId": {
      +            "type": "string"
      +          },
      +          "type": {
      +            "enum": [
      +              "protocol"
      +            ],
      +            "type": "string"
      +          },
      +          "version": {
      +            "minimum": 1,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "projectId",
      +          "type",
      +          "id",
      +          "version"
      +        ],
      +        "type": "object"
      +      },
      +      "scope": {
      +        "enum": [
      +          "run",
      +          "sample"
      +        ]
      +      },
      +      "splits": {
      +        "items": {
      +          "maxLength": 80,
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "maxItems": 32,
      +        "type": "array",
      +        "uniqueItems": true
      +      },
      +      "unit": {
      +        "maxLength": 64,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "unit",
      +      "axis",
      +      "scope"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 64,
      +  "type": "array"
      +}
  2. First observedv0.3.3

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already establish that this is a non-read-only, idempotent, non-destructive save. The description adds lifecycle context — draft vs ready revisions and that implementations pin an exact ready revision — but does not explain expectedRevision concurrency, requestId/idempotency behavior, or what happens on revision conflicts.

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 short sentences with the definition first, lifecycle behavior second, and scope boundary third; there is no filler.

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 complex revisioned save with nested record data and no output schema, it supplies the conceptual model but leaves key operational details unstated. The annotation coverage helps, but expectedRevision and idempotent retry semantics remain unclear.

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 needs to compensate, yet it never explains requestId, projectId, expectedRevision, or record patch-vs-create semantics. 'Draft or ready revision' only vaguely gestures at the status field.

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 gives a specific verb and resource — define/save a method-level contract — and states that it writes a draft or ready revision. It separates contracts from cases/configurations handled by runs, though it does not name a specific sibling tool.

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?

It gives clear timing ('before implementation') and a scope exclusion ('cases/configurations belong to runs, not method contracts'). It stops short of naming the alternative tool for cases/configurations or stating other when-not conditions.

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