Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_record_get

Read-onlyIdempotent

Retrieves one exact research record or historical version by project, type, and ID, enabling inspection of current data or prior revisions.

Instructions

Read one exact record or historical version.

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": {
      "ref": "<ref>"
    },
    "name": "rws_record_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
refYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.2
    • changedInput schema / properties / ref / 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/5.0
Behavior3/5

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

The annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds that historical versions can be read, which is useful behavioral context, but it says nothing about missing records, permissions, or return 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?

The description is a single front-loaded sentence with no wasted words. It is concise and readable, even though the resulting definition is under-specified elsewhere.

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 tool with a required nested ref object, a 20-value type enum, an optional version, and no output schema, the description is far too sparse. It does not explain the record reference structure or what an agent should expect back.

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 0%, so the description must explain the nested ref object, but it does not document projectId, type, id, or the optional version field. The phrase 'historical version' only faintly hints at the version parameter and leaves the rest of the ref structure unexplained.

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 clearly states a specific verb and resource: reading one record, including a historical version. It is more specific than the name alone, but it does not distinguish this tool from nearby siblings such as rws_result_query, rws_get_context, or rws_code_find.

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 explicit guidance on when to use this tool versus alternatives, nor when not to use it. The word 'exact' faintly implies direct lookup rather than querying, but the description never states that distinction or names any sibling.

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