Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

add_bom_table

Add a bill of materials table to a SOLIDWORKS assembly drawing, listing item numbers, part names, and quantities; choose top-level, parts-only, or indented BOM types and optional sheet position.

Instructions

Add a bill of materials table to a drawing of an assembly: item number, part name and quantity per component. With SOLIDWORKS' default table the columns are ITEM NO., PART NUMBER (the file name unless the part says otherwise, not a custom property) and QTY.; add_bom_column adds a property's own column. bom_type: top_level (default; a sub-assembly counts as one item), parts_only or indented. The table goes in the top right corner of the sheet unless x_sheet / y_sheet give its top right corner. Returns the table's rows.

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": "add_bom_table"
  }
}

Input Schema

NameRequiredDescriptionDefault
unitNoUnit of the length inputs: mm (the default, whatever set_units says), cm, m, inch or ft. Results are in mm
viewNoA view of the assembly (default: the first one)
x_sheetNoTop right corner of the table, from the left edge (in unit, mm by default) of the sheet
y_sheetNoTop right corner of the table, from the bottom edge (in unit, mm by default) of the sheet
bom_typeNoWhat the table liststop_level

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?

With no annotations, the description carries the burden and does much of it: it discloses the default column set and what PART NUMBER actually maps to (file name, not a custom property), the default placement, and that it returns the table's rows. Gaps remain for a mutation tool: no mention of permission requirements, failure modes, or behavior when a table already exists on the drawing.

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 with the action and output columns, then defaults and alternatives. It is dense but each sentence adds something; the nested parenthetical about PART NUMBER is slightly clunky but informative rather than wasteful.

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?

Five optional parameters with full schema coverage, no output schema but the return value ('the table's rows') is stated. Defaults for placement, view, unit, and bom_type are all addressed, which is what an agent needs to invoke this safely.

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 a 3 would be baseline, but the description adds real meaning beyond the schema: it explains that top_level counts a sub-assembly as one item, and clarifies that x_sheet/y_sheet denote the table's top right corner and default to the sheet's top right.

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?

Specific verb and resource ('Add a bill of materials table to a drawing of an assembly') with the columns it produces spelled out. It also explicitly contrasts with sibling add_bom_column, so the agent can pick correctly between them.

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?

Clear usage context: default placement is top right of the sheet unless coordinates are given, and bom_type variants are explained with the default called out. The add_bom_column contrast covers one alternative, but there is no explicit statement of when not to use this tool (e.g., sheet already has a BOM).

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