SolidworksMCP-python

Overview Schema Source Related Servers Discussions Admin

set_custom_property

Create or overwrite a text custom property on the active SolidWorks document and read it back to verify storage. Use it to manage fields such as PartNo, Description, DrawnBy, or Revision.

Instructions

Create or overwrite one text custom property on the active document.

Typical names: PartNo, Description, DrawnBy, Revision. The value is read back after writing, so success means it was stored.

Input Schema

Name	Required	Description	Default
`input_data`	Yes	``name`` and ``value``, plus an optional ``configuration``.

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Addedv1.5.0Nov 2, 2026

TDQS

A4.2/5.0

Behavior4/5

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

With no annotations, the description carries the burden and does add real behavioral detail: it discloses overwrite semantics, the text-only limitation, and that the value is read back so success is verifiable. It omits permission/error behavior and cross-configuration effects, keeping it short of a 5.

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?

Three short sentences, front-loaded with the action and scope, followed by concrete examples and the verification guarantee. No filler.

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?

Given an output schema exists and schema coverage is complete, the description covers the essentials an agent needs: operation, target, text-only scope, and success verification. A note on configuration scoping would make it fully complete.

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%, so name, value, and configuration are already documented. The description only echoes the typical name examples and says nothing about the optional configuration parameter or the $PRP link form beyond what the schema provides – baseline 3.

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 clear verb (create or overwrite) plus resource (one text custom property) and scope (the active document). An agent can easily distinguish this from the read-oriented sibling get_custom_properties.

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 clear context for going ahead: it writes/overwrites a text property on the active document. It never names the alternative get_custom_properties or states when not to use this tool, so exclusions are missing, but the intent is unambiguous.

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

Deploy Server