Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_overview_propose

Idempotent

Save a proposed foundation revision for human review without applying it, enabling reviewers to approve or reject changes before they take effect.

Instructions

Save a proposed foundation revision for human review; this does not apply it.

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>",
      "fields": "<fields>",
      "reason": "<reason>",
      "baseRevision": "<baseRevision>"
    },
    "name": "rws_overview_propose"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsYes
reasonYes
projectIdYes
requestIdYes
sourceRefsNo
baseRevisionYes
expectedRevisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.2
    • changedInput schema / properties / sourceRefs / 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

B3.1/5.0
Behavior3/5

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

Annotations already declare non-destructive, idempotent, closed-world behavior. The description adds the crucial behavioral fact that the revision is only proposed for human review and is not applied, which is not in annotations, but it omits concurrency semantics (baseRevision/expectedRevision), approval workflow, and response behavior.

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?

A single front-loaded sentence with no filler, clearly conveying scope and the non-apply caveat.

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 nested seven-parameter proposal mutation with no output schema and no schema descriptions, the description is far too thin. It does not explain required revision parameters, field structure, sourceRefs, or what a proposal result looks like.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the description names no parameters or meanings. For seven parameters, including required requestId, projectId, expectedRevision, reason, and nested fields, it provides no compensation for the lack of schema documentation.

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 ('Save') and resource ('proposed foundation revision') and clarifies it is for human review and not applied, which distinguishes it from an apply operation. It does not explicitly name the overview/apply siblings, so it falls short of a 5.

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

Usage Guidelines3/5

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

Gives the condition for use (human review) and explicitly says it does not apply the revision, implying apply/dismiss are alternatives. However, it does not name rws_overview_apply or state when to prefer that tool, leaving guidance only implied.

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