Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Get faces and edges

get_body_details
Read-only

Lists each part's faces and optional edges with IDs, geometry, area, point, and normal for sketching on faces or applying fillets and chamfers.

Instructions

List the faces (and optionally edges) of each part with their IDs, geometry type, area, a point on the face and its outward normal, all in the configured length unit. Use face IDs as plane in create_sketch to sketch on a face, and edge IDs for fillet / chamfer. Output is capped for very large parts.

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_body_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
part_idNoOnly this part (from list_parts).
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.
configurationNo
include_edgesNoAlso list edges (needed for fillet / chamfer).

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 safety profile is covered. The description adds genuinely useful behavior beyond that: results are expressed in the configured length unit and 'output is capped for very large parts,' warning the agent about truncation on complex geometry.

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, all informative, with the resource and returned fields front-loaded before the usage and truncation notes. Slightly dense but no filler; every clause carries information an agent needs.

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 six parameters, an output schema present, and annotations covering safety, the description covers the remaining essentials: what fields come back, unit behavior, truncation, and how IDs are consumed downstream. Only explicit guidance on part_id/configuration scoping is left thin, which the schema covers.

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 83%, so the schema already documents document_id, element_id, workspace_id, configuration, and part_id. The description only indirectly touches parameters ('optionally edges' for include_edges, 'configured length unit' for configuration), adding little meaning beyond what the schema states.

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?

The description opens with a specific verb and resource ('List the faces (and optionally edges) of each part') and enumerates the returned attributes (IDs, geometry type, area, point, outward normal). It also names the downstream consumers (create_sketch, fillet, chamfer), so an agent can tell what this tool is for versus geometry-mutating 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?

It gives clear situational context: call this when you need face IDs to use as `plane` in create_sketch, or edge IDs for fillet/chamfer. It does not explicitly say when NOT to use it (e.g., versus get_part_properties or list_parts), but the trigger conditions are concrete enough to act on.

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