Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Get configuration inputs

get_configuration
Read-only

Lists a Part Studio's configuration inputs, options, and defaults so you can identify labels or IDs and choose a valid variant for measurement or inspection.

Instructions

List the configuration inputs of a Part Studio (for example a 'Size' list with M10 and M18, or a 'Length'), with their options and defaults. Names are the labels shown in Onshape; for an input made in Onshape's UI the generated id (and option_ids) are shown beside them. Other tools take a configuration such as {"Size": "M18"} (labels or IDs) to measure or look at one variant.

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

Input Schema

NameRequiredDescriptionDefault
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
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the description needn't restate safety. It adds genuinely useful behavior beyond that: names are Onshape UI labels, and generated `id`/`option_ids` appear beside them only for inputs created in the UI, which tells the agent what the returned data will look like and how labels map to identifiers.

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-loads the core purpose and return shape, then adds the label/ID subtlety and the cross-tool usage note. Sentences are dense but each carries information; the parenthetical URL guidance is schema territory but the prose itself stays lean.

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, so return values need no explanation, and annotations cover the safety profile. The description supplies the one non-obvious piece an agent needs — how labels relate to IDs and how a `configuration` argument is shaped for downstream tools — leaving little missing for a simple read-only lookup.

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%, with each of document_id, element_id, and workspace_id documented including URL-extraction hints and the workspace default. The description adds no parameter-level detail beyond the schema, so the 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 (list) and resource (configuration inputs of a Part Studio), then concretely illustrates with examples ('Size' list with M10/M18, 'Length') and their options and defaults. An agent can distinguish this read of configuration metadata from set_configuration_input 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 Guidelines4/5

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

Gives clear context by explaining that other tools consume a `configuration` such as {"Size": "M18"} to measure or look at one variant, which implies calling this first to discover valid labels/IDs. It does not explicitly say when not to use it or name set_configuration_input as the mutation counterpart, so it stops short of full routing guidance.

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