FlexSim MCP Server

Overview Schema Source Related Servers Discussions Admin

flexsim_prepare_gui_model

Creates a new FlexSim .fsm by copying the GUI template and opens it, so you can safely build and run a model without altering the original.

Instructions

Copy the GUI template to a new .fsm and open that copy in the FlexSim window.

Work on the copy, never on the template. The model's On Model Open trigger runs mcp_start(),
so the window connects by itself in about 20 s; check flexsim_gui_status. If it does not
(for example the MCP server was restarted), run `mcp_start();` in its Script console.

Args:
    model_path: Path of the new .fsm file (must not exist yet)

Input Schema

TableJSON Schema

Name	Required	Description	Default
`params`	Yes

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Oct 5, 2026

TDQS

A4.7/5.0

Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses the auto-connect via the On Model Open trigger, the ~20 s delay, the status-check step, and the manual `mcp_start();` fallback. The 'must not exist yet' constraint also flags a creation-safety behavior not visible in the schema.

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 core action, followed by operational notes and then the args block. Each sentence earns its place; nothing is redundant padding.

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?

An output schema exists, so return values need not be explained, and the description fully covers the operational workflow, precondition, and recovery step for this single-parameter tool. 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.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% (the property is only typed as a string with minLength 1), so the description must compensate. It does: model_path is 'Path of the new .fsm file (must not exist yet)', adding format and precondition semantics the schema lacks.

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?

The description uses a specific verb and resource: 'Copy the GUI template to a new .fsm and open that copy in the FlexSim window.' This clearly distinguishes it from siblings like flexsim_new_model (creates fresh), flexsim_open_model (opens existing), and flexsim_clone_model (clones). An agent can tell exactly what this does without opening the 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?

It gives explicit operating guidance ('Work on the copy, never on the template') and the post-copy connection workflow including the fallback if mcp_start() doesn't fire. What's missing is an explicit statement of when to choose this over flexsim_new_model or flexsim_open_model, but the workflow context is strong.

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

Deploy Server