Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Insert BOM Table

insert_bom_table

Adds a bill-of-materials table to an assembly view on the active SolidWorks drawing, with configurable BOM type and optional table position or template.

Instructions

Insert a bill-of-materials table for an assembly view on the active drawing.

Use it on an assembly drawing after placing a view of the assembly (see list_drawing_views for view names). Needs: an open, active drawing with a view of an assembly. Changes: adds a BOM table to the sheet. Returns: data with view, bom_type, template and row_count. An unknown view is not_found and the message lists the views.

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

Input Schema

NameRequiredDescriptionDefault
input_dataNoThe table. `view_name` (a view of an assembly) is required; `bom_type` ("top_level_only", "parts_only" or "indented"), `template_path` and the position `x_mm`/`y_mm` (the sheet's BOM anchor when omitted) have defaults.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-idempotent, non-destructive write, and the description adds genuine context beyond them: the required state (open active drawing with an assembly view), the concrete effect (adds a table to the sheet), and the error contract (unknown view → `not_found` with available views listed). The one real gap is that it never warns that repeat calls add another table, leaving the non-idempotent hint unexplained.

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?

Front-loaded with the action, then structured into Needs/Changes/Returns, with the prerequisite and the sibling pointer in a single parenthetical. No sentence is redundant against the schema or annotations.

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?

For a single nested-parameter write tool with an output schema, the definition covers preconditions, side effect, and the failure mode. The return-shape sentence is redundant with the output schema but harmless, and nothing an agent needs to invoke 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 the nested schema already documents view_name, bom_type enum values, template_path default, and the anchor behavior of x_mm/y_mm. The description restates the same facts (required `view_name`, bom_type values, defaults) without adding format or interaction details, so it does not exceed the schema baseline.

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 with scope: "Insert a bill-of-materials table for an assembly view on the active drawing." The scope constraints (assembly view, active drawing) make it distinguishable from neighbors like add_drawing_view or manage_design_table without opening a schema.

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 an explicit sequencing precondition ("after placing a view of the assembly") and routes the agent to `list_drawing_views` to obtain a valid view name. It stops short of stating when not to use it or naming an alternative BOM/table tool, so it is clear context rather than full routing.

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