Skip to main content
Glama
0xFFD

openfoam-mcp

by 0xFFD

set_dict

Edit OpenFOAM dictionary entries safely via foamDictionary, setting, adding, or removing values and reading back the new data.

Instructions

Edit dictionary entries safely via foamDictionary (set/add/remove), then read back the new values.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
setNoEntries to set or add: {'endTime': '2000', 'boundaryField/inlet/value': 'uniform (5 0 0)', 'RAS/model': 'kOmegaSST', 'boundaryField/outlet': '{ type zeroGradient; }'}. Values use OpenFOAM syntax without the trailing ';'.
caseYesCase name in the workspace (e.g. 'pitzDaily') or an absolute path inside an allowed root.
fileYesDictionary path relative to the case, e.g. 'system/controlDict', '0/U', 'constant/momentumTransport'.
removeNoEntry paths to remove.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=false, lowering the disclosure bar. The description usefully adds that the edit goes through foamDictionary and that new values are read back, but 'safely' is undefined and it doesn't reconcile the explicit 'remove' operation with the non-destructive annotation.

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 front-loaded sentence that conveys the mechanism, the operations and the read-back behavior with no filler. Every clause earns its place.

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

Completeness4/5

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

For a 4-parameter mutation tool with fully documented params and no output schema, the description covers the essentials and even notes that values are read back after the edit. Minor gaps remain around prerequisites/permissions, but nothing required to invoke it is missing.

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%, with rich per-parameter docs including OpenFOAM syntax examples for 'set', path forms for 'case'/'file' and 'remove'. The description adds nothing beyond the schema, so the baseline 3 for high-coverage schemas is appropriate.

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+resource ('Edit dictionary entries'), names the underlying mechanism (foamDictionary) and enumerates the operations (set/add/remove), which cleanly separates it from get_dict, read_file and write_file. It stops short of explicitly naming a sibling as the wrong choice, so it lands at 4 rather than 5.

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

Usage Guidelines3/5

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

The description implies the usage context (editing OpenFOAM dictionary entries) but gives no explicit when-to-use or when-not-to-use guidance. With siblings like write_file, get_dict and read_file available, an agent would benefit from knowing that this is the targeted dict-editing path, and that guidance is absent.

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