research-workflow-studio

Overview Schema Source Related Servers Discussions Admin

rws_server_save

Idempotent

Registers a versioned local or SSH workspace using an SSH alias instead of credentials; registration records the workspace without opening a connection.

Instructions

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

Input Schema

Name	Required	Description	Default
`record`	Yes
`projectId`	Yes
`requestId`	Yes
`expectedRevision`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Addedv0.4.2Oct 30, 2026

TDQS

B3.4/5.0

Behavior4/5

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

Annotations already cover the safety profile (non-readOnly, idempotent, non-destructive, closed-world), so the description's real contribution is two non-obvious traits: SSH aliases must be supplied instead of credentials, and registration performs no connectivity check, so an unreachable workspace will still register. Those are exactly the behaviors an agent would otherwise get wrong.

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?

Two sentences, no filler, with the identity of the tool front-loaded and the two caveats trailing. Nothing repeats the annotations or the schema verbatim.

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?

No output schema and a nested, conditional `record` object make this a complex call, yet the description leaves the concurrency token, the record's alternative accepted shapes, and project scoping entirely undocumented. An agent could not construct a correct `record` from this text alone.

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 coverage is 0% and the description explains none of the four required parameters. It says nothing about requestId, projectId, the optimistic-concurrency `expectedRevision`, or the nested `record` with its either/or shape (an existing `id`, or `title`+`transport`+`workspaceRoot`). Only the sshAlias field is obliquely covered by "using an SSH alias".

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: "Register a versioned local/SSH workspace". The word "workspace" plus the SSH-alias constraint distinguishes it from save-style siblings (rws_environment_save, rws_repository_save, rws_spec_save), though no sibling is named explicitly.

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?

"never credentials" and "Registration does not connect" imply the intended calling posture, but the description never says when to choose this tool over the many other *_save/_register siblings, nor what prerequisites exist. Usage is only inferable.

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