Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Add Drawing Note

add_note

Place a text note on the active drawing sheet at a specified millimetre position for general annotations such as material or finish.

Instructions

Place a text note on the active drawing sheet at a position in millimetres.

Use it for general notes such as material or finish. For a title block, use generate_drawing_package, which fills one. Needs: an open, active drawing. Changes: adds a note to the sheet. Returns: data with text, position, positioned (whether the position was applied) and font_size_points.

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": {
      "input_data": "<input_data>"
    },
    "name": "add_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
input_dataYesThe note. `text`, `position_x` and `position_y` (mm from the sheet's lower-left corner) are required; `font_size` (points) has a default.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare a non-destructive, non-idempotent write, so the bar is lower, yet the description adds the prerequisite of an active drawing and a genuinely non-obvious detail: `positioned` reports whether the position was actually applied. The Returns section largely duplicates the output schema, so it stops short of 5.

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-loaded placement sentence, then clearly labeled Needs/Changes/Returns blocks — easy to scan. The Returns enumeration is redundant with the existing output schema and slightly dilutes the concision.

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?

Covers what the tool does, the precondition, the mutation effect, and the routing alternative, while the output schema handles return shape and annotations handle the safety profile. Nothing an agent needs to call it correctly is missing.

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 coverage is 100% and already documents text, position_x/position_y in mm from the lower-left corner, font_size in points, and leader_attachment. The description's millimetre/point notes restate the schema rather than adding semantics, so baseline 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?

States a specific verb and resource ('Place a text note on the active drawing sheet') plus the coordinate unit. It also explicitly contrasts itself with `generate_drawing_package` for title blocks, so an agent can separate the two without inspecting schemas.

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 the intended use case ('general notes such as material or finish'), names the alternative for the excluded case (title block → `generate_drawing_package`), and states the precondition ('Needs: an open, active drawing').

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

Deploy Server

Other Tools