FreeShip MCP

简体中文

A Windows MCP server for FreeShip model inspection, control-net editing, hull transformation, geometry diagnostics and engineering exports. Powered by the native FreeShip Plus engine.

Features

• Read and write FBM/FTM models, including fv335 and fv462.

• Edit control points, edges and faces; scale geometry and apply Lackenby transformations.

• Generate stations, waterlines and buttocks at specified positions.

• Inspect topology, sampled curve quality and coordinate constraints.

• Calculate hydrostatics at individual drafts or across a draft range.

• Export three-view DXF linesplans and CSV/XLSX reports with source manifests.

Related MCP server: SolidworksMCP

Installation

Platform: Windows 10/11 x64. Transport: stdio.

Install from source with Python 3.11 or later:

git clone https://github.com/jiangshirong/FreeShip-MCP.git
cd FreeShip-MCP
py -3.11 -m venv .venv
.venv\Scripts\python -m pip install -r requirements-dev.lock
.venv\Scripts\python -m pip install --no-deps --no-build-isolation -e .
scripts\bootstrap-toolchain.ps1
scripts\build-engine.ps1

Configuration

Create a workspace directory and add the server to your MCP client configuration:

{
  "mcpServers": {
    "freeship": {
      "command": "C:\\MCP\\FreeShip-MCP\\.venv\\Scripts\\freeship-mcp.exe",
      "args": ["--workspace", "C:\\HullWork", "--timeout", "120"]
    }
  }
}

Set command to the absolute path of .venv\Scripts\freeship-mcp.exe in your checkout.

Paths are restricted to the configured workspace. Outputs use new filenames. Logs are written to stderr.

Tools

API physical units are metres, metric tonnes and degrees; areas and volumes use m² and m³. Legacy FBM text encoding supports cp1252, cp1251 and utf8.

Local edits require the model SHA-256 returned by inspection. Target values and tolerances are explicit inputs. Version 0.3.2 uses native protocol 3; update the server and engine together.

Model-writing tools default to output_version: 335. Use 0 to preserve the input version or 462 to select fv462. output_path is used exactly as specified, without version suffixes.

Documentation

• Local editing, diagnostics and DXF options

• Units and numerical semantics

• Target verification and export manifests

• Build and packaging

• Tests and validation coverage

• Synthetic test models

Development

py -3.11 -m venv .venv
.venv\Scripts\python -m pip install -r requirements-dev.lock
.venv\Scripts\python -m pip install --no-deps --no-build-isolation -e .
scripts\bootstrap-toolchain.ps1
scripts\build-engine.ps1
.venv\Scripts\python -m pytest -q

The build uses Free Pascal 3.2.2 and Lazarus 3.2. Pinned upstream sources and build instructions are included in the repository; see UPSTREAM.json and upstream changes.

License

GPL-3.0-or-later. Original FreeShip and dependency notices are retained in NOTICE. This project is an independent FreeShip adapter.