Skip to main content
Glama
gabrielserrao

pyResToolbox MCP Server

validate_simulation_deck

Validate ECLIPSE simulation decks by checking INCLUDE file references, identifying missing files, and optionally creating complete archives for sharing or archiving.

Instructions

Validate and process ECLIPSE simulation deck with INCLUDE files.

DECK MANAGEMENT TOOL - Recursively process ECLIPSE/Intersect simulation decks to find all INCLUDE files, validate references, and optionally create a complete archive.

What It Does:

  • Parses main DATA file for INCLUDE keywords

  • Recursively follows INCLUDE chains

  • Validates all referenced files exist

  • Identifies missing or broken references

  • Optionally creates zip archive with all files

Applications:

  • Deck Validation: Ensure all files present before submission

  • Deck Transfer: Create complete archive for sharing

  • Version Control: Bundle all files for archiving

  • QC Check: Verify deck completeness before cluster runs

Workflow:

  1. Specify main DATA file(s) to check

  2. Tool recursively finds all INCLUDE files

  3. Validates each file exists

  4. Reports missing files or broken paths

  5. Optionally creates zip with all referenced files

INCLUDE File Support:

  • Absolute paths: /full/path/to/file.inc

  • Relative paths: ../INCLUDE/GRID.GRDECL

  • Same directory: SCHEDULE.INC

  • Nested INCLUDE chains: INCLUDE files that reference other INCLUDE files

Output Formats:

  • Summary of all files found

  • List of missing/broken references

  • Optional: ZIP archive with complete deck

Args: request: List of DATA files, zip option, console output preference

Returns: Dictionary with file inventory, validation results, and optional zip path

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
requestYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure and does so effectively. It describes the recursive processing behavior, validation of file existence, identification of missing references, optional archiving functionality, and support for various path types (absolute, relative, same directory, nested chains). It also specifies output formats. The only minor gap is lack of explicit mention about whether this is a read-only operation or has side effects.

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?

The description is well-structured with clear sections (What It Does, Applications, Workflow, INCLUDE File Support, Output Formats, Args, Returns) that make it easy to scan. Every sentence adds value, with no redundant information. The bold headers provide excellent visual organization while maintaining efficiency.

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

Completeness5/5

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

Given the tool's complexity (recursive file processing, validation, optional archiving) and the presence of an output schema (which handles return values), the description provides complete context. It covers purpose, usage scenarios, workflow, file path support, output formats, and parameter semantics. With no annotations, it successfully conveys the tool's behavior and capabilities.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate. The 'Args' section provides high-level parameter semantics: 'List of DATA files, zip option, console output preference'. The workflow section further clarifies that files2scrape are 'main DATA file(s) to check'. While it doesn't detail every property of the nested ZipSimDeckRequest object, it gives sufficient context for an agent to understand what parameters are needed.

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

Purpose5/5

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

The description clearly states the tool's purpose with specific verbs ('validate and process', 'recursively process', 'find all INCLUDE files', 'validate references', 'create archive') and resources ('ECLIPSE simulation deck', 'INCLUDE files'). It explicitly distinguishes this deck management tool from all sibling tools, which are exclusively fluid property calculators with no overlap in functionality.

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

Usage Guidelines5/5

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

The 'Applications' section provides explicit guidance on when to use this tool: for deck validation before submission, deck transfer for sharing, version control archiving, and QC checks before cluster runs. It also implicitly suggests when not to use it (for fluid property calculations like all sibling tools). The workflow section further clarifies the typical usage sequence.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/gabrielserrao/pyrestoolbox-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server