FD Solutions MCP Server

Overview Schema Source Related Servers Discussions Admin

Add object

add

Create SimWorks simulation objects by kind, optionally at specified coordinates or with custom mesh data; configure them with set_property and keep the returned Name for later selection.

Instructions

Add a simulation object (SimWorks add* only; configure with set_property).

After success, the reply includes Name='...'. Record that exact name for later select / set / delete. Do not call add again for an object that already exists (especially port_group, mode_port, fdtd) — if select fails, use object_action path forms instead of re-adding. Docs: https://simworks.net/knowledge-base/Script-Commands_setting-objects

Input Schema

Name	Required	Description
`kind`	Yes	Object to add (SimWorks script add* commands). Structures: polygon, triangle, rectangle, circle, ellipse, sector, circular_ring, elliptic_ring, sphere, pyramid, cone, linear_waveguide, arc_waveguide, linear_taper, sidewall_linear, sidewall_arc, sidewall_bezier, 2d_rectangle, 2d_polygon, photonic_crystal, planar_solid, equation, import_nk. planar_solid: optional vertices+facets for custom mesh (addplanarsolid overloads); otherwise default rectangle. Groups: group, structure_group, assembly_group, analysis_group. library_object: addobject from built-in library (needs script_id; omit script_id to list library ids). Sources: dipole, plane, tfsf, mode_source, gaussian, import_source, port_group, mode_port, eme_port, import_generation. Monitors: power_monitor, field_monitor, time_monitor, index_monitor, eme_profile, eme_index. Solvers/mesh: fdtd, fde, fdfd, eme, rcwa, fdcharge, mesh. Creation only — configure with set_property. Positions are SI meters. port_group / eme_port / import_generation take no coordinates. mode_port needs an active port group; eme_port needs an active EME port group; import_generation needs an existing fdcharge solver. Do not re-add an existing object; remember the Name returned by add.
`x_pos`	No	Center x in meters (SI). Omit with y/z to use API default (no-arg add*).
`y_pos`	No	Center y in meters (SI).
`z_pos`	No	Center z in meters (SI).
`facets`	No	For kind=planar_solid only: face list; each face is vertex indices (1-based, right-hand rule), e.g. [[1,4,3,2],[1,5,8,4],...]. Must be paired with vertices.
`vertices`	No	For kind=planar_solid only: Nx3 vertex matrix in meters, each row [x, y, z]. Must be paired with facets.
`script_id`	No	For kind=library_object: library script id. Omit to list available objects.

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Oct 29, 2026

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 does real work: it discloses the return convention (reply includes Name='...'), instructs the agent to persist that exact name for later select/set/delete, and warns about idempotency failures on specific kinds. It does not cover permissions, side effects on existing geometry, or whether the operation is reversible, so it falls short of fully carrying the no-annotation burden.

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?

The parenthetical scoping clause is front-loaded in the first sentence, followed by the success/name-capture rule and the re-add warning in priority order. No sentence is filler; the docs URL is a compact pointer rather than prose padding.

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 51-value enum creation tool with an output schema and full schema coverage, the description supplies the creation-only semantic, the name-capture workflow, and the non-idempotency warning that structured fields cannot express. Remaining gaps (side effects, failure modes) are modest given the output schema exists.

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 description coverage is 100%, so the baseline is 3; the per-parameter enum doc already explains kind categories, SI meter units, planar_solid vertices/facets pairing, and library_object script_id. The tool description does not add syntax or format meaning beyond what the schema already states.

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 ('Add a simulation object') and immediately scopes it against siblings by declaring it is the SimWorks add* family only and that configuration belongs to set_property. An agent can distinguish it from set_property and object_action without reading either schema.

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 explicit when-not guidance ('Do not call add again for an object that already exists (especially port_group, mode_port, fdtd)') and names the fallback alternative ('use object_action path forms instead of re-adding') plus the configuration alternative set_property. This is exactly the routing information an agent needs.

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