Skip to main content
Glama
0xFFD

openfoam-mcp

by 0xFFD

get_dict

Read-only

Read OpenFOAM dictionary files or extract a single entry by path via foamDictionary, with optional macro expansion and keyword listing.

Instructions

Read a dictionary or one entry through OpenFOAM's foamDictionary (authoritative parsing).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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'.
entryNoEntry path with '/' separators, e.g. 'boundaryField/inlet' or 'SIMPLE/residualControl'. Omit for the whole file.
expandNoExpand #include, $macros and #calc first.
keywordsNoOnly list the keywords at that level.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations declare readOnlyHint=true and openWorldHint=false, so safety is already covered. The description adds that parsing is authoritative via foamDictionary, which is real value beyond annotations, but it says nothing about failure modes (missing files, malformed dicts) or the shape of returned parsed values.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One tight sentence with no waste, front-loading the action. The parenthetical is useful but slightly elliptical ('authoritative parsing' assumes the reader knows foamDictionary's role).

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?

A read-only tool with full schema coverage and annotations needs little more, but the 'authoritative' claim implies a contrast with the sibling read_file that is left unexplored, and there is no output schema to explain the parsed return shape. Adequate but leaving clear gaps.

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 coverage is 100%, so all five parameters are already documented in the schema, including entry, expand, and keywords. The description adds no parameter-level meaning beyond the schema baseline, which is adequate but unremarkable.

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 (Read) and resource (dictionary or one entry) via foamDictionary. The 'authoritative parsing' qualifier hints at why this tool exists versus sibling read_file, but does not name that sibling explicitly, so sibling differentiation is implied rather than stated.

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, no conditions for choosing this over read_file or foam_reference, and no mention of what the 'authoritative' qualifier excludes. The agent must infer from the name alone that this is the preferred dictionary reader.

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