Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Capture screenshot

capture_screenshot
Read-only

Render shaded screenshots of a Part Studio or Assembly from standard camera angles, save them to disk, and optionally return images to visually verify shape, hole placement, and orientation.

Instructions

Render a shaded screenshot of a Part Studio or Assembly from one or more standard camera angles. Images are always saved to disk. Whether they are also returned to you for visual inspection depends on the review flag / server setting - with review off you get only paths and metadata, which keeps token use low. Use it to visually verify what you built (shape, hole placement, orientation).

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

Input Schema

NameRequiredDescriptionDefault
viewsNoCamera angles to render. Every extra view is an extra image (and, if review is on, extra tokens).
widthNoImage width in pixels (default from server settings).
heightNoImage height in pixels (default from server settings).
reviewNotrue: send the image(s) to you so you can look at them (costs tokens, ~width*height/750 per image). false: only save them to disk and return the file paths (no image tokens). Omit to use the server's ONSHAPE_SCREENSHOT_REVIEW setting.
part_idNoRender only this part (Part Studios only).
element_idYesElement (tab) ID: the string after /e/ in the Onshape URL. Get it from get_document.
show_edgesNoDraw visible edges.
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

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the readOnlyHint/openWorldHint annotations by disclosing the side effect that images are always written to disk, that the response content varies with the review flag or server setting, and that image tokens scale with resolution. This is exactly the kind of behavioral context annotations cannot carry.

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 core action, then the storage/return behavior, then the motivating use case. Minor filler in 'which keeps token use low' and the parenthetical examples, but nothing that should be cut outright.

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?

For a 10-parameter tool with no output schema, the description covers the essentials an agent needs: what gets rendered, that output is always persisted, what the response contains under each review setting, and the token cost model. Return-shape information that would otherwise be missing is supplied.

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

Parameters4/5

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

Schema coverage is already 90%, so the schema carries most parameter meaning, but the description reinforces the review flag's effect on output and token cost, tying the flag to observable consequences rather than restating its type.

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 ('Render a shaded screenshot of a Part Studio or Assembly') plus the scope (standard camera angles), so an agent can immediately tell this is an image-rendering tool rather than a geometry-modifying one like extrude or fillet.

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 an explicit use case ('visually verify what you built (shape, hole placement, orientation)') and explains the review on/off tradeoff that governs token spend. It does not name when not to use it or point at a sibling alternative, which keeps it short of a 5.

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