bulc_run_fds
Destructive
Start FDS fire simulation in the background for building design analysis, allowing users to monitor progress separately while the simulation runs.
Instructions
Start FDS simulation. Runs the simulation in background and returns immediately. Use bulc_get_fds_status to monitor progress.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mpiProcesses | No | Number of MPI processes. Default: auto (based on mesh count) | |
| openmpThreads | No | Number of OpenMP threads per process. Default: 1 | |
| outputPath | No | Output directory. Default: BULC_result folder |
Implementation Reference
- src/tools/fds-run.ts:190-197 (handler)Handler implementation for the 'bulc_run_fds' MCP tool. Validates input arguments using RunFdsSchema and sends a 'run_fds' command to the BULC client.
case "bulc_run_fds": { const validated = RunFdsSchema.parse(args); result = await client.sendCommand({ action: "run_fds", params: validated, }); break; } - src/tools/fds-run.ts:69-96 (schema)MCP tool schema definition for 'bulc_run_fds', including input schema, description, and annotations.
{ name: "bulc_run_fds", description: "Start FDS simulation. " + "Runs the simulation in background and returns immediately. " + "Use bulc_get_fds_status to monitor progress.", inputSchema: { type: "object" as const, properties: { mpiProcesses: { type: "integer", description: "Number of MPI processes. Default: auto (based on mesh count)", }, openmpThreads: { type: "integer", description: "Number of OpenMP threads per process. Default: 1", }, outputPath: { type: "string", description: "Output directory. Default: BULC_result folder", }, }, }, annotations: { readOnlyHint: false, destructiveHint: true, }, }, - src/index.ts:112-121 (registration)Registration logic in main server that routes 'bulc_run_fds' tool calls to the handleFdsRunTool handler.
if ( name === "bulc_preview_fds" || name === "bulc_validate_fds" || name === "bulc_export_fds" || name === "bulc_run_fds" || name === "bulc_get_fds_status" || name === "bulc_stop_fds" ) { return await handleFdsRunTool(name, safeArgs); } - src/tools/fds-run.ts:143-147 (schema)Zod validation schema used for input validation in the bulc_run_fds handler.
const RunFdsSchema = z.object({ mpiProcesses: z.number().int().positive().optional(), openmpThreads: z.number().int().positive().optional(), outputPath: z.string().optional(), }); - src/index.ts:48-48 (registration)Includes fdsRunTools (containing bulc_run_fds schema) in the allTools list registered with the MCP server.
...fdsRunTools, // 6 tools: preview, validate, export, run, status, stop