Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

add_bom_column

Add a custom property column, such as Material or PartNo, to a SOLIDWORKS drawing BOM table and identify items whose cells are empty.

Instructions

Add a column to the drawing's bill of materials (add_bom_table) that shows a custom property of each item: property is its name, e.g. Material, PartNo or Description; title is the column heading (default: the property name; the result says so). Returns the table as it now reads, and lists the items whose cell is empty (their part has no such property: set_custom_properties on that part). For each part's material, give every part a Material property linked to it ('"SW-Material@"' with set_custom_properties: the file name only, e.g. '"SW-Material@Bracket.SLDPRT"', quotes included) and show that: SW-Material itself is refused, as SolidWorks shows it as '$PRP:...' in the table.

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": {
      "property": "<property>"
    },
    "name": "add_bom_column"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNoColumn heading (default: the property name)
propertyYesCustom property to show, e.g. Material

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations, so the description carries the burden, and it does disclose return behavior ('returns the table as it now reads, and lists the items whose cell is empty') and a refusal case with the reason (SolidWorks renders SW-Material as '$PRP:...'). It does not say whether the added column persists, whether the operation is reversible, or what permissions are needed for a drawing mutation.

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

Conciseness3/5

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

Purpose is front-loaded, but the trailing material instructions are a nested run-on with stacked parentheticals and an awkward pivot ('and show that: SW-Material itself is refused'). The key fact that SW-Material is rejected is buried mid-sentence rather than stated plainly.

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?

For a two-parameter mutation with no output schema, the definition covers return content, empty-cell signaling, the material edge case, and the helper sibling. Only persistence/undo behavior and the requirement of a pre-existing BOM table are left implicit.

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 100%, so baseline is 3, but the description adds real meaning: examples of valid property names (Material, PartNo, Description), the title default behavior, and the exact quoted syntax required for linked material properties. That is meaning beyond the schema's terse parameter docs.

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 up front: 'Add a column to the drawing's bill of materials (add_bom_table)'. The tool is distinguishable from add_bom_table itself and from set_custom_properties, which is named only as a follow-up for empty cells.

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 concrete workflow guidance: when a cell is empty, the part lacks the property and set_custom_properties should be used on that part; and how to populate a Material column via the linked 'SW-Material@<part file>' property. It also warns SW-Material is refused. It lacks explicit prerequisites (a BOM table must already exist) and any when-not-to-use statement.

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