Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_research_save

Idempotent

Save a research question or hypothesis with revision-aware updates, and declare intended spec or code links before execution without treating them as evidence.

Instructions

Save a research question or optional hypothesis. implementationLinks declares intended uses of exact spec/code revisions before execution; these links are not evidence and do not decide scientific validity.

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_research_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. Changed5 schema fields changedv0.4.2
    • changedInput schema / properties / record / anyOf
      Previous value: -[
      -  {
      -    "required": [
      -      "id"
      -    ]
      -  },
      -  {
      -    "additionalProperties": false,
      -    "if": {
      -      "properties": {
      -        "kind": {
      -          "const": "hypothesis"
      -        }
      -      },
      -      "required": [
      -        "kind"
      -      ]
      -    },
      -    "properties": {
      -      "hypothesis": {
      -        "description": "A concrete hypothesis. Explicit null clears an optional statement; omission preserves it when updating. Judged research remains subject to human review.",
      -        "minLength": 1,
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "id": {
      -        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      -        "type": "string"
      -      },
      -      "judgment": {
      -        "description": "Human scientific decision. Explicit null removes it only with human authority; omission preserves the previous decision.",
      -        "oneOf": [
      -          {
      -            "type": "null"
      -          },
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "evidenceRefs": {
      -                "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"
      -              },
      -              "label": {
      -                "type": "string"
      -              },
      -              "limitations": {
      -                "oneOf": [
      -                  {
      -                    "type": "string"
      -                  },
      -                  {
      -                    "items": {
      -                      "type": "string"
      -                    },
      -                    "type": "array"
      -                  }
      -                ]
      -              },
      -              "summary": {
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "label"
      -            ],
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "kind": {
      -        "enum": [
      -          "hypothesis",
      -          "exploration",
      -          "reproduction"
      -        ]
      -      },
      -      "parentRefs": {
      -        "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"
      -      },
      -      "question": {
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "stage": {
      -        "enum": [
      -          "idea",
      -          "formal",
      -          "ablation"
      -        ]
      -      },
      -      "status": {
      -        "enum": [
      -          "planned",
      -          "running",
      -          "completed",
      -          "failed",
      -          "partial"
      -        ]
      -      },
      -      "title": {
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "title",
      -      "question"
      -    ],
      -    "then": {
      -      "required": [
      -        "hypothesis"
      -      ]
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "required": [
      +      "id"
      +    ]
      +  },
      +  {
      +    "additionalProperties": false,
      +    "if": {
      +      "properties": {
      +        "kind": {
      +          "const": "hypothesis"
      +        }
      +      },
      +      "required": [
      +        "kind"
      +      ]
      +    },
      +    "properties": {
      +      "hypothesis": {
      +        "description": "A concrete hypothesis. Explicit null clears an optional statement; omission preserves it when updating. Judged research remains subject to human review.",
      +        "minLength": 1,
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "id": {
      +        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      +        "type": "string"
      +      },
      +      "implementationLinks": {
      +        "description": "Declared research purposes, not actual execution or evidence. Pin a specification before implementation, or reference existing code. Omission preserves existing links; [] clears them.",
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "note": {
      +              "maxLength": 1000,
      +              "type": "string"
      +            },
      +            "role": {
      +              "enum": [
      +                "implementation",
      +                "control",
      +                "diagnostic"
      +              ]
      +            },
      +            "targetRef": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "id": {
      +                  "type": "string"
      +                },
      +                "projectId": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "enum": [
      +                    "spec",
      +                    "code"
      +                  ],
      +                  "type": "string"
      +                },
      +                "version": {
      +                  "minimum": 1,
      +                  "type": "integer"
      +                }
      +              },
      +              "required": [
      +                "projectId",
      +                "type",
      +                "id",
      +                "version"
      +              ],
      +              "type": "object"
      +            }
      +          },
      +          "required": [
      +            "targetRef",
      +            "role"
      +          ],
      +          "type": "object"
      +        },
      +        "maxItems": 32,
      +        "type": "array"
      +      },
      +      "judgment": {
      +        "description": "Human scientific decision. Explicit null removes it only with human authority; omission preserves the previous decision.",
      +        "oneOf": [
      +          {
      +            "type": "null"
      +          },
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "evidenceRefs": {
      +                "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"
      +              },
      +              "label": {
      +                "type": "string"
      +              },
      +              "limitations": {
      +                "oneOf": [
      +                  {
      +                    "type": "string"
      +                  },
      +                  {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  }
      +                ]
      +              },
      +              "summary": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "label"
      +            ],
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "kind": {
      +        "enum": [
      +          "hypothesis",
      +          "exploration",
      +          "reproduction"
      +        ]
      +      },
      +      "parentRefs": {
      +        "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"
      +      },
      +      "question": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "stage": {
      +        "enum": [
      +          "idea",
      +          "formal",
      +          "ablation"
      +        ]
      +      },
      +      "status": {
      +        "enum": [
      +          "planned",
      +          "running",
      +          "completed",
      +          "failed",
      +          "partial",
      +          "unknown"
      +        ]
      +      },
      +      "title": {
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "title",
      +      "question"
      +    ],
      +    "then": {
      +      "required": [
      +        "hypothesis"
      +      ]
      +    },
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / record / properties / implementationLinks
      Added value: +{
      +  "description": "Declared research purposes, not actual execution or evidence. Pin a specification before implementation, or reference existing code. Omission preserves existing links; [] clears them.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "note": {
      +        "maxLength": 1000,
      +        "type": "string"
      +      },
      +      "role": {
      +        "enum": [
      +          "implementation",
      +          "control",
      +          "diagnostic"
      +        ]
      +      },
      +      "targetRef": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": "string"
      +          },
      +          "projectId": {
      +            "type": "string"
      +          },
      +          "type": {
      +            "enum": [
      +              "spec",
      +              "code"
      +            ],
      +            "type": "string"
      +          },
      +          "version": {
      +            "minimum": 1,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "projectId",
      +          "type",
      +          "id",
      +          "version"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "targetRef",
      +      "role"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 32,
      +  "type": "array"
      +}
    • changedInput schema / properties / record / properties / judgment / oneOf
      Previous value: -[
      -  {
      -    "type": "null"
      -  },
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "evidenceRefs": {
      -        "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"
      -      },
      -      "label": {
      -        "type": "string"
      -      },
      -      "limitations": {
      -        "oneOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "items": {
      -              "type": "string"
      -            },
      -            "type": "array"
      -          }
      -        ]
      -      },
      -      "summary": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "label"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "type": "null"
      +  },
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "evidenceRefs": {
      +        "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"
      +      },
      +      "label": {
      +        "type": "string"
      +      },
      +      "limitations": {
      +        "oneOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          }
      +        ]
      +      },
      +      "summary": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "label"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / record / properties / parentRefs / 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 / status / enum
      Previous value: -[
      -  "planned",
      -  "running",
      -  "completed",
      -  "failed",
      -  "partial"
      -]New value: +[
      +  "planned",
      +  "running",
      +  "completed",
      +  "failed",
      +  "partial",
      +  "unknown"
      +]
  2. First observedv0.3.3

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare write/idempotent/non-destructive semantics, so the description only needs to add context. It usefully clarifies that implementationLinks are declarations of intent, not evidence, and don't confer scientific validity — a real semantic constraint. However, it omits the concurrency behavior implied by expectedRevision and the fact that this is an upsert with field preservation.

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?

Two sentences, front-loaded with the core action and no filler. The second sentence is dense but earns its place by preventing a likely misinterpretation of implementationLinks.

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

Completeness2/5

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

For a mutation tool with a deep nested schema, four required params, and no output schema, the description covers only one nested field's semantics. It says nothing about idempotency via requestId, revision conflicts, or partial-update/preservation behavior that the record schema documents.

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 adds meaning for exactly one nested concept (implementationLinks) while leaving requestId (presumably an idempotency key) and expectedRevision (optimistic concurrency) entirely unexplained — despite these being required parameters. The critical distinction between

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?

States a specific verb and resource: 'Save a research question or optional hypothesis.' The named content (question/hypothesis) implicitly distinguishes it from rws_experiment_save or rws_spec_save, but the description never explicitly says so.

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?

No guidance on when to use this versus the many sibling save tools (experiment, spec, protocol, conversation), and no mention of prerequisites such as needing an existing project or revision. Only the implementationLinks caveat hints at correct usage.

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