Skip to main content
Glama

Pin a project to a version of a shared code module

r3_module_pin
DestructiveIdempotent

Choose which version of a shared code module ONE project runs: version n pins it (the project keeps that version when the module changes), version null follows the latest again. moduleId names someone else's PUBLIC module (it is then the project's module of that name). The pin lives in the project's import map, not in the code: no script changes. Open editors of the project reload. A release (go-live) freezes the versions the project runs at that moment anyway. Not taken back by r3_editor_undo: pin again.

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": {
      "projectId": "<projectId>",
      "name": "<name>",
      "version": "<version>"
    },
    "name": "r3_module_pin"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesThe module name the project's scripts import, e.g. "ship-core".
versionYesThe version to pin, or null to follow the latest.
moduleIdNoSomeone else's public module (its id from r3_module_read); omit for your own.
projectIdYesThe project.

Output Schema

NameRequiredDescriptionDefault
mapYes
answerYesThis answer in words: what was done, what R3 measured, decided or refused, and what to do next. The same text as the result's text block. Read it: the fields beside it are the data, this is the guidance.
modulesYes
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Goes well past annotations by explaining where the pin lives (the project's import map, not code), that no script changes occur, that open editors reload, and that a go-live release already freezes versions. This makes the destructiveHint/openWorldHint meaningful to the agent rather than unexplained.

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?

Front-loaded with the core choice, then side effects, then the undo caveat. Dense but each clause carries information; a couple of sentences (import-map location, release freeze) could be tightened but nothing is filler.

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

Completeness4/5

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

With an output schema present and rich annotations, the description covers the main behavioral questions (mutability, side effects, reversibility). It leaves error conditions and permission requirements unaddressed, but those are minor for this scope.

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

Parameters4/5

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

Schema coverage is 100% so the baseline is 3; the description adds value by clarifying that moduleId refers to someone else's public module and that the project then treats it as its own module of that name, and by restating the null semantics for version in operational terms.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource with scope: 'Choose which version of a shared code module ONE project runs', plus the two modes (pin to n, null follows latest). It is clearly the version-pinning operation and distinct from r3_module_write/read/list siblings.

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

Usage Guidelines4/5

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

Explains the two usable states (integer pins, null unpins), when to supply moduleId (someone else's public module) versus omit it (your own), and explicitly says the action is not reversible via r3_editor_undo and must be re-pinned. It stops short of naming a sibling alternative, but the usage context is unambiguous.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources