Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_report_create_revision

Idempotent

Create a report revision with an immutable foundation and transitive evidence snapshots to preserve auditable research provenance.

Instructions

Create a report version with immutable foundation and transitive evidence snapshots.

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

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. Changed8 schema fields changedv0.4.2
    • changedInput schema / properties / record / anyOf
      Previous value: -[
      -  {
      -    "required": [
      -      "id"
      -    ]
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "analysisRefs": {
      -        "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"
      -      },
      -      "comparisonRefs": {
      -        "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"
      -      },
      -      "evaluationRefs": {
      -        "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"
      -      },
      -      "generatorCodeRef": {
      -        "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"
      -      },
      -      "generatorRunRef": {
      -        "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"
      -      },
      -      "markdown": {
      -        "type": "string"
      -      },
      -      "researchRefs": {
      -        "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"
      -      }
      -    },
      -    "required": [
      -      "title",
      -      "markdown"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "required": [
      +      "id"
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "analysisRefs": {
      +        "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"
      +      },
      +      "comparisonRefs": {
      +        "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"
      +      },
      +      "evaluationRefs": {
      +        "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"
      +      },
      +      "generatorCodeRef": {
      +        "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"
      +      },
      +      "generatorRunRef": {
      +        "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"
      +      },
      +      "markdown": {
      +        "type": "string"
      +      },
      +      "researchRefs": {
      +        "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"
      +      }
      +    },
      +    "required": [
      +      "title",
      +      "markdown"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / record / properties / analysisRefs / 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 / comparisonRefs / 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 / evaluationRefs / 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 / generatorCodeRef / 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 / generatorRunRef / 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"
      +]
    • changedInput schema / properties / record / properties / researchRefs / 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"
      +]
  2. First observedv0.3.3

TDQS

C2.8/5.0
Behavior3/5

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

Annotations already disclose that this is a non-read-only, idempotent, non-destructive mutation. The description adds some behavioral context by noting immutable foundations and transitive evidence snapshots, but it does not explain what is frozen, how snapshots are resolved, or what permissions may be required.

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

Conciseness3/5

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

The description is a single front-loaded sentence with no wasted words, but it is under-specified for a complex mutation involving nested evidence references. Brevity here comes at the cost of the context an agent needs to invoke the tool correctly.

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 complex tool with nested objects, four required parameters, no output schema, and low schema description coverage, the description is insufficient. It omits the concurrency model, idempotency semantics, project scoping, and the distinction between creating a new report record and revising an existing one.

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 but does not. It never explains expectedRevision as an optimistic concurrency guard, requestId as an idempotency key, projectId scoping, or the record field's partial-update behavior. The only hint is vague reference to evidence snapshots.

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: 'Create a report version.' It is clear what operation is being performed, but the added phrase 'immutable foundation and transitive evidence snapshots' is opaque jargon and does not distinguish this tool from the many other save/create tools in the sibling list.

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 guidance on when to use this tool versus alternatives, no prerequisites, and no mention of the required concurrency parameter expectedRevision or the idempotent requestId. The description merely states what the tool does, leaving all invocation context to inference.

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