Skip to main content
Glama
research-workflow-studio

research-workflow-studio

by BorgDiven

rws_code_register

Idempotent

Registers an immutable code identity and explicit parent references without reading or running the code path.

Instructions

Register an immutable code identity and explicit parent references; never reads or runs the path.

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

Input Schema

NameRequiredDescriptionDefault
recordYes
projectIdYes
requestIdYes
expectedRevisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.4.2
    • changedInput schema / properties / record / properties / kind / enum
      Previous value: -[
      -  "inference",
      -  "evaluation",
      -  "analysis",
      -  "report"
      -]New value: +[
      +  "training",
      +  "inference",
      +  "evaluation",
      +  "analysis",
      +  "report"
      +]
    • 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"
      +]
    • addedInput schema / properties / record / properties / repositoryRef
      Added value: +{
      +  "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",
      +    "version"
      +  ],
      +  "type": "object"
      +}
    • changedInput schema / properties / record / properties / specRef / 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.9/5.0
Behavior3/5

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

Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=true), so the bar is lower, and the description still adds real value: the record is immutable and the path is never read or executed, which no annotation conveys. However it says nothing about optimistic concurrency via expectedRevision, what happens on a revision conflict, or how requestId deduplicates retries — meaningful gaps for a mutation tool.

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?

A single front-loaded sentence with zero filler; the negative constraint is placed after the core action, which is the right order. It is efficient but sits close to under-specification for a schema this nested.

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 deeply nested record object, a conditional required-field rule, and no output schema, the description covers only immutability and no-execution. It omits the revision/idempotency contract and the specRef-triggered field requirements that an agent must satisfy to call this successfully.

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 carry the burden and largely does not. It hints at parentRefs ("explicit parent references") and at path-related fields via "the path," but requestId, projectId, and especially expectedRevision — the concurrency token — are completely unexplained, as is the conditional requirement that specRef forces entrypoint/modulePath/repository/commit/capabilities/checkEvidence.

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 ("Register") and a specific resource ("an immutable code identity" plus "explicit parent references"), which differentiates it from sibling registrars like rws_run_register and rws_artifact_register. It stops short of an explicit sibling comparison, but the resource is distinct enough to route on.

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 statement of when to use this versus rws_code_find, rws_repository_save, or the other register tools, and no prerequisites or preconditions given. The only guidance-like clause, "never reads or runs the path," describes behavior rather than selection criteria.

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