Skip to main content
Glama
rhyne1012

OpenVSP MCP (Maintained Fork)

openvsp.create_model

Destructive

Creates a new .vsp3 OpenVSP model without an input file, using the simple_aircraft template or trusted AngelScript, and saves model, script, log, and manifest in a unique run directory.

Instructions

Create a new .vsp3 model from the four-component simple_aircraft template or custom trusted AngelScript, without an input model. Runs OpenVSP and retains the model, script, log and manifest in a unique directory under output_dir; no VSPAERO solve. Use openvsp.modify to edit an existing source model.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
requestYesNew model template and output settings.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
timingsNoMeasured operation phase durations in seconds; available phase keys depend on execution.
log_pathYesAbsolute path to the retained OpenVSP process log.
versionsNoPackage version, MCP SDK version and package SHA-256, with observed native versions when available. Package identity changes on source/metadata updates.
warningsNoReference/unit/atmospheric consistency warnings and omitted undefined ratios; no automatic corrections.
artifactsNoMapping of run-relative artifact names to absolute file paths; files remain after the call.
operationNoExecuted operation: create, modify, preview, preflight or run_vspaero; reflects the enforced operation rather than the legacy input flag.run_vspaero
preflightNoSelected thick/thin geometry IDs and requested settings when preflight ran; empty otherwise. Does not certify mesh quality.
result_pathNoAbsolute path to the solver .adb result; null for operations without a VSPAERO solve.
script_pathYesAbsolute path to the retained AngelScript automation script.
coefficientsNoNative polar column names and finite unscaled values for a verified solve; empty otherwise. Undefined ratios are omitted with reasons in numerical_quality.unavailable_coefficients. Includes condition columns; AoA/Beta are degrees and Re/1e6 is Reynolds in millions.
geometry_pathYesAbsolute path to the validated model saved in the run directory, including for source-replacing edits.
manifest_pathYesAbsolute path to this operation's manifest.json; pass as manifest_file to openvsp.read_results.
run_directoryYesAbsolute path to the unique persistent directory containing this operation's artifacts.
analysis_inputsNoRequested analysis settings for solve/preflight, including defaults; empty for other operations. Units follow VSPAeroSettings and no conversion is applied.
parameter_valuesNoFinal native readback values keyed by edited parameter ID; native units, empty when no parameters were edited.
numerical_qualityNoObserved iteration-history diagnostics for a solve; convergence is not_assessed and mesh study not_performed. Empty for non-solver operations.
effective_settingsNoVerified solver-file values and observed CPU-thread information for a solve; empty before solving. Separate from requested analysis_inputs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.8.0
    • changedOutput schema / properties / coefficients / description
      Previous value: -"Native polar column names and unscaled numeric values for a verified solve; empty otherwise. Includes condition columns as well as dimensionless aerodynamic coefficients; AoA/Beta are degrees and Re/1e6 is Reynolds in millions."New value: +"Native polar column names and finite unscaled values for a verified solve; empty otherwise. Undefined ratios are omitted with reasons in numerical_quality.unavailable_coefficients. Includes condition columns; AoA/Beta are degrees and Re/1e6 is Reynolds in millions."
    • changedOutput schema / properties / warnings / description
      Previous value: -"Reference/unit/atmospheric consistency warnings from existing checks; no automatic corrections."New value: +"Reference/unit/atmospheric consistency warnings and omitted undefined ratios; no automatic corrections."
  2. Changed24 schema fields changedv0.7.0
    • addedInput schema / $defs / CreateModelRequest / properties / case_name / description
      Added value: +"Run-directory prefix and model filename stem (default aircraft), not a filesystem path."
    • addedInput schema / $defs / CreateModelRequest / properties / output_dir / description
      Added value: +"Required parent directory for a new unique persistent run. Tilde expands and relative paths use the server working directory; no input model is needed."
    • addedInput schema / $defs / CreateModelRequest / properties / set_commands / description
      Added value: +"Trusted AngelScript statements appended after template commands, or used to build a custom model. May perform arbitrary I/O with server privileges; defaults to none."
    • addedInput schema / $defs / CreateModelRequest / properties / template / description
      Added value: +"simple_aircraft creates a fuselage, main wing and horizontal/vertical tails; custom starts empty and requires set_commands that add geometry."
    • addedInput schema / $defs / CreateModelRequest / properties / timeout_seconds / description
      Added value: +"Native OpenVSP process timeout in seconds (default 120); preparation, resource admission and validation are outside this timeout."
    • changedInput schema / $defs / VSPCommand / properties / command / description
      Previous value: -"Trusted AngelScript statement; runs with server privileges"New value: +"Trusted AngelScript statement executed with server-process privileges. May perform arbitrary file or external I/O; private-copy/source-preservation guarantees do not constrain the statement itself."
    • addedInput schema / properties / request / description
      Added value: +"New model template and output settings."
    • addedOutput schema / properties / analysis_inputs / description
      Added value: +"Requested analysis settings for solve/preflight, including defaults; empty for other operations. Units follow VSPAeroSettings and no conversion is applied."
    • addedOutput schema / properties / artifacts / description
      Added value: +"Mapping of run-relative artifact names to absolute file paths; files remain after the call."
    • addedOutput schema / properties / coefficients / description
      Added value: +"Native polar column names and unscaled numeric values for a verified solve; empty otherwise. Includes condition columns as well as dimensionless aerodynamic coefficients; AoA/Beta are degrees and Re/1e6 is Reynolds in millions."
    • addedOutput schema / properties / effective_settings / description
      Added value: +"Verified solver-file values and observed CPU-thread information for a solve; empty before solving. Separate from requested analysis_inputs."
    • addedOutput schema / properties / geometry_path / description
      Added value: +"Absolute path to the validated model saved in the run directory, including for source-replacing edits."
    • addedOutput schema / properties / log_path / description
      Added value: +"Absolute path to the retained OpenVSP process log."
    • addedOutput schema / properties / manifest_path / description
      Added value: +"Absolute path to this operation's manifest.json; pass as manifest_file to openvsp.read_results."
    • addedOutput schema / properties / numerical_quality / description
      Added value: +"Observed iteration-history diagnostics for a solve; convergence is not_assessed and mesh study not_performed. Empty for non-solver operations."
    • addedOutput schema / properties / operation / description
      Added value: +"Executed operation: create, modify, preview, preflight or run_vspaero; reflects the enforced operation rather than the legacy input flag."
    • addedOutput schema / properties / parameter_values / description
      Added value: +"Final native readback values keyed by edited parameter ID; native units, empty when no parameters were edited."
    • addedOutput schema / properties / preflight / description
      Added value: +"Selected thick/thin geometry IDs and requested settings when preflight ran; empty otherwise. Does not certify mesh quality."
    • addedOutput schema / properties / result_path / description
      Added value: +"Absolute path to the solver .adb result; null for operations without a VSPAERO solve."
    • addedOutput schema / properties / run_directory / description
      Added value: +"Absolute path to the unique persistent directory containing this operation's artifacts."
    • addedOutput schema / properties / script_path / description
      Added value: +"Absolute path to the retained AngelScript automation script."
    • addedOutput schema / properties / timings / description
      Added value: +"Measured operation phase durations in seconds; available phase keys depend on execution."
    • addedOutput schema / properties / versions / description
      Added value: +"Package version, MCP SDK version and package SHA-256, with observed native versions when available. Package identity changes on source/metadata updates."
    • addedOutput schema / properties / warnings / description
      Added value: +"Reference/unit/atmospheric consistency warnings from existing checks; no automatic corrections."
  3. First observedv0.6.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuinely new behavioral context: OpenVSP is actually run, the model/script/log/manifest are retained in a unique directory under output_dir, and no VSPAERO solve occurs. It does not mention the native-process timeout boundary or the privileged nature of AngelScript, though the schema covers the latter.

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?

Two dense sentences, front-loaded with the core action and scope, followed by the artifact-retention behavior and the sibling routing. No filler.

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 annotations cover the destructive/non-idempotent profile. The description supplies the remaining operational essentials: what is produced, where it is persisted, and that no VSPAERO solve runs.

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 every parameter already carries documentation, and the description's template detail largely restates the schema ('simple_aircraft creates a fuselage, main wing and horizontal/vertical tails'). It adds no format, syntax or default information beyond the structured fields, so the baseline 3 applies.

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 ('Create a new .vsp3 model') and enumerates the two creation paths (simple_aircraft template vs. custom AngelScript). It also explicitly distinguishes itself from the sibling that edits existing models, so an agent can separate it from openvsp.modify 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 the selecting condition ('without an input model') and names the alternative explicitly ('Use openvsp.modify to edit an existing source model'). The when-to-use and when-to-use-something-else routing is fully spelled out.

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