Skip to main content
Glama
onshape-jamcp

onshape-jamcp

Check Onshape connection

whoami
Read-only

Verify configured Onshape credentials by identifying the connected account, confirming API keys or OAuth sign-in work, and distinguishing bad keys from bad document IDs when a 401 occurs.

Instructions

Check that the configured credentials (API keys or OAuth sign-in) really work, by asking Onshape which account they belong to: returns connected, user_id, name and the base_url in use. Use it first in a session or whenever another tool answers 401, and to tell a wrong key from a wrong document ID. Read-only, one request, nothing is changed. Onshape answers 200 with an empty body to credentials it does not recognise, so this call treats that "anonymous" reply as a failure and explains how to fix the keys. It does not show which permissions (read / write / delete) the key has - a 403 from a modeling tool means the key lacks the write scope. For this server's own settings use get_settings.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "whoami"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and openWorldHint, but the description adds real behavioral detail beyond them: a single request, nothing changed, and the crucial quirk that Onshape returns 200 with an empty body for unrecognised credentials, which this call treats as failure. It also discloses a limitation (permissions are not shown) and how to interpret a 403 from modeling tools.

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?

Purpose and trigger are front-loaded, and the diagnostic quirk about empty-body 200 responses is genuinely load-bearing rather than filler. The final clause about get_settings and the 403 note make it slightly longer than strictly needed, but no sentence is wasted.

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 zero-parameter connectivity probe, the description covers the trigger, the failure modes (401, anonymous 200, 403 scope) and the remediation. Return values are already in the output schema, so nothing an agent needs to call or interpret this tool is missing.

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?

The tool takes zero parameters, so the baseline is 4 and there is no parameter meaning left to add. The description instead documents the return payload (connected, user_id, name, base_url), which is useful but redundant with the output 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 ('check that the configured credentials really work, by asking Onshape which account they belong to') and even enumerates the returned fields. It explicitly distinguishes itself from the sibling get_settings ('For this server's own settings use get_settings'), so an agent can route between them without opening either schema.

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 trigger conditions: 'Use it first in a session or whenever another tool answers 401', plus the diagnostic use case of telling a wrong key from a wrong document ID. It also names the alternative tool and the boundary condition that selects it.

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