solidworks-mcp

Overview Schema Source Related Servers Discussions Admin

solidworks_sketch_begin

Destructive

Create or select a 2D sketch on a specified plane and add simple entities like lines, circles, or rectangles in a single call.

Instructions

Legacy convenience: create/select a 2D sketch on a plane and add a batch of simple entities in one call (line/circle/rectangle). For the full entity/relation/dimension set, use solidworks_sketch's operation dispatch (begin/add_entities/fillet/chamfer/... /exit).

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": {
      "plane_name": "<plane_name>",
      "entities": "<entities>"
    },
    "name": "solidworks_sketch_begin"
  }
}

Input Schema

Name	Required	Description	Default
`document`	No
`entities`	Yes
`plane_name`	Yes

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.2.0Sep 8, 2026

TDQS

A4.1/5.0

Behavior3/5

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

Annotations already flag destructive and non-idempotent behavior, and the description adds create/select and batch-add semantics without contradicting those flags. However, it does not disclose side effects such as whether an existing sketch is overwritten or how selection behaves.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two concise sentences with no redundant filler. It front-loads the purpose and then provides a compact pointer to the richer alternative, making it efficient and scannable.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description is adequate for a convenience wrapper and an output schema exists, so return values need not be detailed. However, it leaves gaps around entity object formatting and behavior when a sketch already exists, which are important for correct invocation.

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?

The description gives functional meaning to plane_name and entities by mentioning a plane and simple line/circle/rectangle entities, but it does not describe the optional document parameter or the exact structure of each entity object. With 0% schema description coverage, this is only partial compensation.

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 clearly identifies the operation as a legacy convenience for creating/selecting a 2D sketch on a plane and adding a batch of simple entities (line/circle/rectangle) in one call. It names the resource and action and distinguishes it from the more complete sketch operation dispatch.

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?

The description explicitly directs users to solidworks_sketch's operation dispatch when the full entity/relation/dimension set is needed, providing a clear when-not-to-use and an alternative. It implies this tool is for the simple batch case, which is sufficient guidance.

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

Deploy Server