Skip to main content
Glama
0xFFD

openfoam-mcp

by 0xFFD

read_log

Read-only

Inspect OpenFOAM simulation logs by returning the tail or grepping for patterns like warnings, bounding, or Courant numbers to monitor solver progress.

Instructions

Read the tail of a log, or grep it (e.g. 'FOAM Warning|bounding|Courant').

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
logNoLog file, e.g. 'log.foamRun' or just 'foamRun'. Default: most recently modified log.
caseYesCase name in the workspace (e.g. 'pitzDaily') or an absolute path inside an allowed root.
grepNoRegex; return matching lines (with line numbers) instead of the tail.
tailNoNumber of trailing lines to return (ignored with grep).

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 already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds mode-specific behavior (grep replaces the tail, example pattern) which is useful, but says nothing about return format, truncation, or what happens when the log is missing.

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?

A single compact sentence, front-loaded with the primary action, with the grep example appended economically. Very little waste, though the dual-mode phrasing is slightly compressed.

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 read-only log inspection tool with a fully documented schema and no output schema, the description covers the essentials. It omits return shape and how it interacts with the broader case/file tools, leaving some gaps an agent must infer.

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% – every parameter (log, case, grep, tail) is already well documented in the schema, including defaults. The description's regex example adds only marginal value. Baseline 3 is appropriate since the schema does the heavy lifting.

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 (log) and distinguishes the two operating modes: tail vs grep, with a concrete regex example. It does not, however, differentiate itself from siblings such as read_file or read_postprocessing, which an agent could easily confuse with it.

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?

The description explains the two internal modes but never says when to reach for read_log versus read_file, list_files, or read_postprocessing. No prerequisites, no exclusions, no routing guidance for the agent.

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