Content
# CONVERGE Studio MCP
An unofficial, local Model Context Protocol server for automating CONVERGE Studio 5 on
Windows. It combines a TypeScript MCP server with a PowerShell and Studio JavaScript bridge.
The server exposes:
- 25 MCP tools: Studio, CSI, CGM, GUI, coverage, and bounded raw-solver operations.
- The compatible 53-command Studio bridge.
- Classified catalogs for 153 CSI methods and 55 CGM methods.
- A 13-chapter, 248-entry manual capability matrix.
- An original Chinese functional digest that omits redistributed vendor prose, page images,
layout, examples, assets, local paths, and credentials.
- Working-copy defaults, explicit mutation gates, path allowlists, bounded output, and
PID-verified solver job control.
This repository contains no CONVERGE binaries, licenses, manuals, customer cases, geometry,
or solver output. A separately licensed local CONVERGE Studio installation is required.
## Repository layout
```text
studio-mcp/ TypeScript MCP server, tests, catalogs, and public documentation
studio-js/ PowerShell launcher, Windows GUI driver, and Studio JavaScript backend
```
Keep these directories as siblings. The MCP server discovers `../studio-js` by default.
## Requirements
- Windows 10/11 with Windows PowerShell 5.1
- Node.js 20 or newer
- A licensed CONVERGE Studio 5.x installation
- The vendor `CONVERGE_Studio.cmd` launcher
Direct launch of `CONVERGE_Studio.exe` is intentionally rejected.
## Build and verify
```powershell
git clone https://github.com/Legiiiit/converge-studio-mcp.git
Set-Location .\converge-studio-mcp\studio-mcp
npm ci
npm run check
npm test
npm run smoke
npm audit
```
The default smoke test does not launch Studio. Live Studio, GUI, and solver execution tests
require a licensed local installation and explicit opt-in environment variables.
## Register in Codex
Build first, then register the compiled stdio server:
```powershell
$repo = (Resolve-Path .\converge-studio-mcp).Path
codex mcp add converge-studio `
--env "CONVERGE_STUDIO_CMD=D:\Program Files\Convergent Science\CONVERGE CFD\5.1.1\CONVERGE_Studio\x64\bin\CONVERGE_Studio.cmd" `
-- "C:\Program Files\nodejs\node.exe" "$repo\studio-mcp\dist\src\index.js"
```
Studio discovery also checks conventional `C:` and `D:` Program Files locations. All
mutation, GUI, solver file-write, launch, and stop capabilities remain disabled or
double-gated unless the corresponding environment and call-level confirmations are supplied.
See [the complete MCP documentation](studio-mcp/README.md), the
[sanitized Chinese functional digest](studio-mcp/resources/manual-digest.zh-CN.md), and the
[generated coverage matrix](studio-mcp/coverage/coverage-matrix.md).
## GitHub Actions
CI runs the catalog/coverage drift checks, strict TypeScript build, unit/protocol tests,
stdio smoke test, and dependency audit. It deliberately does not run CONVERGE Studio because
GitHub-hosted runners do not have the licensed Windows application or an interactive desktop.
## Project status
The baseline is CONVERGE Studio 5.1.1. Other 5.x releases use runtime discovery and explicit
capability statuses; unsupported, internal, unavailable, and unverified functions are not
reported as verified.
## License and trademark
The original source in this repository is available under the [MIT License](LICENSE).
CONVERGE, CONVERGE Studio, and related names are trademarks of their respective owner.
This community project is not affiliated with, endorsed by, or sponsored by Convergent Science.
