Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Rename a part or tab

rename
Idempotent

Assign descriptive names to parts or tabs in Onshape, replacing placeholder labels like 'Part 2' or 'Part Studio 1' with meaningful identifiers.

Instructions

Give a part, or a whole tab (Part Studio / Assembly), a descriptive name. Do this by default: a part still called 'Part 2' or a tab still called 'Part Studio 1' says nothing. Keep a name the user chose; rename only placeholders (flagged has_default_name by get_document and list_parts) unless the user asks otherwise.

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": {
      "document_id": "<document_id>",
      "element_id": "<element_id>",
      "name": "<name>"
    },
    "name": "rename"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesThe new name, e.g. 'M10x40 Hex Bolt' for a part or 'M10 Fasteners' for a tab.
part_idNoPart ID from list_parts to rename that part. Leave out to rename the whole tab (the Part Studio / Assembly itself).
element_idYesElement (tab) ID: the string after /e/ in the Onshape URL. Get it from get_document.
document_idYesOnshape document ID: the 24-character hex string after /documents/ in the document URL. Get it from list_documents.
workspace_idNoWorkspace ID (the string after /w/ in the URL). Optional - defaults to the document's main workspace.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=true and openWorldHint=true, so the safety and repeat-call profile is covered upstream. The description adds policy context about only renaming placeholders, which is genuinely useful, but says nothing about permissions, whether renaming breaks references elsewhere, or what the mutation returns. With annotations carrying the behavioral load, this is adequate rather than rich.

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?

Three sentences, front-loaded with the action, then the default policy, then the exception. Efficient and scannable, with only slight redundancy between the 'Part 2' and 'Part Studio 1' examples.

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?

An output schema exists and annotations cover safety and idempotency, so the description does not need to explain return values. It supplies the one thing structured fields cannot: the policy on when renaming is appropriate. Nothing essential to correct invocation is missing.

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

Parameters3/5

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

Schema description coverage is 100%, including the crucial part_id vs element_id distinction ('leave out to rename the whole tab'), so the schema already does the heavy lifting. The description reinforces the part-vs-tab choice but adds no format, length, or ID-sourcing detail beyond what the schema states. Baseline 3 applies.

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 (rename) plus the two distinct resources it acts on: a part, or a whole tab (Part Studio / Assembly). It also names the sibling tools that flag placeholder names (get_document, list_parts), so an agent can separate this from the many feature-creation siblings without opening the schema.

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

Usage Guidelines5/5

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

Gives an explicit default ('Do this by default'), an explicit exclusion ('Keep a name the user chose'), and the condition that overrides it ('unless the user asks otherwise'). The decision rule is anchored to a concrete signal (has_default_name from get_document/list_parts), leaving little to inference.

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