Skip to main content
Glama
0xFFD

openfoam-mcp

by 0xFFD

render

Read-only

Generate a flow or mesh image from an OpenFOAM case using headless ParaView, returning the image and metadata.

Instructions

Render a picture of the flow or mesh with ParaView (headless) and return it as an image plus metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
caseYesCase name in the workspace (e.g. 'pitzDaily') or an absolute path inside an allowed root.
modeNoauto: whole domain for 2-D cases, mid-plane slice for 3-D. patches: colour boundary patches (e.g. pressure on a body). contour: iso-surface of contour_field at iso_value. streamlines: of vector `field`.auto
timeNo'latest', 'first' or a time value.latest
viewNoCamera: 'auto', 'iso', '+x', '-x', '+y', '-y', '+z', '-z' (camera on that side, looking back).auto
zoomNoZoom factor >1 to magnify (centre of domain).
edgesNoDraw mesh edges.
fieldNoField to colour by (e.g. 'U', 'p'). Omit with mode='mesh'.
focusNoPatch or group to frame (e.g. 'motorBikeGroup', 'wall'); slices pass through it by default.
rangeNo[min, max] colour range.
widthNo
heightNo
patchesNoPatch/group names for mode='patches'.
colormapNocoolwarm, viridis, jet, turbo, inferno, plasma, rainbow, blue-red, grayscale.coolwarm
componentNoVector component (default Magnitude).
iso_valueNo
backgroundNolight
seed_point1No
seed_point2No
slice_normalNoSlice normal, e.g. 'y' or [0,1,0].
slice_originNoSlice origin (default: domain centre).
contour_fieldNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description usefully adds that ParaView runs headless and that the result is an image plus metadata, but says nothing about execution cost, latency, or prerequisite state (e.g. requiring completed simulation data).

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?

A single tight sentence, front-loaded with the action and ending with the observable result. No filler or restatement of the name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 21-parameter rendering tool with no output schema, the description is adequate but thin. It covers what the tool produces but not the prerequisites, the image format/location, or how the mode-dependent parameters combine, leaving the agent to reconstruct the workflow.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

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

With 21 parameters and only 67% schema description coverage, the description carries a compensation burden and contributes zero parameter meaning. It does not clarify the mode/field/patches interplay or any of the undocumented parameters (width, height, iso_value, seed points, contour_field).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (render) and resource (flow/mesh picture via headless ParaView) plus the return type (image plus metadata). It is clearly distinguishable from siblings like post_process or field_stats, though it never names an alternative explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No when-to-use guidance at all: nothing says whether the case must already be solved, how this relates to post_process or field_stats, or when rendering is or isn't appropriate. The agent must infer the workflow context.

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