Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Add or change a configuration input

set_configuration_input
Idempotent

Add or replace a named configuration input in a Part Studio to create dropdown lists or numeric parameters that drive model dimensions.

Instructions

Add a configuration input to a Part Studio, or replace the input of the same name. Only when the user asks for configurations. To make dimensions depend on a list input, use set_variable with by_option.

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": "set_configuration_input"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindNoType of input.list
nameYesInput name, e.g. 'Size' or 'Length'. Number inputs are usable in expressions as '#Length'.
defaultNoList: the default option (first one if omitted). Number inputs: the default value (length in the configured unit, degrees for an angle).
maximumNoNumber inputs: highest value.
minimumNoNumber inputs: lowest value.
optionsNoFor a list: the choices, e.g. ['M10', 'M18'] (at least two).
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.4/5.0
Behavior4/5

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

Annotations already declare mutation (readOnlyHint=false), idempotence, and non-destructiveness; the description adds the key unannotated trait that a same-named input is replaced rather than duplicated, which aligns with idempotentHint and tells the agent the call is safe to repeat. It stops short of saying what happens to existing features that reference a replaced input, which is the main residual behavioral risk.

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?

Three short clauses with zero filler: action and upsert behavior first, then the usage gate, then the alternative routing. Every sentence earns its place and the most decision-relevant information is front-loaded.

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?

For a 9-parameter mutation tool this is well covered: an output schema exists so return values need no explanation, annotations carry the safety profile, and the schema documents all parameters. The only meaningful omission is the effect of replacing an input on dependent features or variables, which an agent would want to know before overwriting.

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 coverage is 100%, with per-parameter descriptions covering kind, name regex, defaults, min/max, options, and how to obtain document/element IDs, so the schema carries parameter meaning fully. The description adds nothing parameter-level beyond the cross-reference to set_variable's `by_option`, which keeps it at the baseline for a fully documented schema.

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 ('Add a configuration input to a Part Studio') and adds the upsert semantics ('or replace the input of the same name') in the first sentence. It is immediately distinguishable from set_variable, which it explicitly names for a different job.

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 both a gating condition ('Only when the user asks for configurations') and an explicit alternative with its selecting condition: use set_variable with `by_option` when dimension-to-list dependency is wanted. This is the when/when-not/alternative pattern done properly.

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