Skip to main content
Glama
onshape-jamcp

onshape-jamcp

List parts

list_parts
Read-only

Retrieves the solid and surface bodies a Part Studio produces, returning part IDs, names, body types, and hidden status so you can target parts in downstream modeling and property tools.

Instructions

List the parts (solid and surface bodies) a Part Studio currently produces: part_id, name, body_type and hidden, one request, read-only. Use it to get the part IDs that other tools take - get_part_properties and get_body_details (to look at one part), rename, only_parts / merge_with / part_ids of extrude and the pattern tools, boolean, insert_instance. Call it again after anything that merges or splits parts (a boolean, an extrude that adds): IDs can change. A part flagged has_default_name is still called "Part N": give it a descriptive name with rename. For the feature tree use list_features; for the tabs of a document get_document.

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

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.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and the description reinforces it with 'one request, read-only'. Beyond that it discloses genuinely non-obvious behavior: part IDs are unstable and can change after a boolean or an additive extrude, and parts flagged has_default_name still carry a placeholder 'Part N' label. It does not discuss result size or limits, so it falls just short of the top mark.

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 verb, resource and return fields, then moves to consumers and caveats. The consumer list is long but each name is there to make the tool's role as an ID source unambiguous; only the 'read-only' restatement of the annotation is arguably redundant.

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

Completeness5/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 prose, and the description covers what matters for correct invocation: what the IDs are for, when they go stale, the has_default_name follow-up, and where to look for related but different data.

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%, so the schema already explains document_id, element_id and the optional workspace_id default. The description adds no parameter-level meaning beyond that, so the baseline of 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?

Opens with a specific verb and resource - 'List the parts (solid and surface bodies) a Part Studio currently produces' - and enumerates the returned fields (part_id, name, body_type, hidden). It is immediately distinguishable from list_features and get_document, both of which are explicitly named as different resources.

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 concrete downstream consumers of the returned part IDs (get_part_properties, get_body_details, rename, extrude/pattern part_ids, boolean, insert_instance), states the re-invocation condition ('Call it again after anything that merges or splits parts'), and routes the agent elsewhere for the feature tree and document tabs.

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