Skip to main content
Glama
msweeney-pnnl

eplusout-mcp

initialize_model_map

Initializes or refreshes a cached map of EnergyPlus model files by scanning the directory for .epJSON, .sql, and .htm files. Run this first to enable efficient access to model data.

Instructions

Initialize or refresh the model map cache for EnergyPlus models.

Scans a directory for EnergyPlus model files (.epJSON, .sql, .htm) and creates a cached model map for efficient access. Call this first before accessing model data.

Args: directory: Directory containing EnergyPlus model files. Defaults to 'DEFUALT_DIRECTORY'.

Returns: Status message confirming successful initialization.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
directoryNoeplus_files/prescriptive_variability_sample

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations provided, the description carries the burden of disclosing behavior; it does state that the tool scans a directory, builds/refreshes a cached model map, and returns a status message. However, it does not mention failure modes, what happens to existing cached data on refresh, or how the cache is stored, which are relevant details for a cache-writing operation.

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?

The description is organized with an overview, a usage note, Args, and Returns, and the core purpose is front-loaded. The incorrect default and typo prevent a perfect score, but the structure is otherwise compact and efficient.

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 one-parameter initializer, the description covers the main flow, call order, and return type, and an output schema exists. It is incomplete about edge cases such as nonexistent directories, empty scans, or cache refresh side effects, and the wrong default value weakens overall reliability.

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?

The description identifies the directory parameter's role and mentions the file extensions scanned, which adds meaning beyond the schema. However, it claims the default is 'DEFUALT_DIRECTORY' while the schema default is 'eplus_files/prescriptive_variability_sample'; this misspelled and incorrect default is misleading for an agent deciding whether to pass the parameter.

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 states a specific verb ('Initialize or refresh') and resource ('the model map cache for EnergyPlus models'), and explains the mechanism by listing the scanned file types. 'Call this first before accessing model data' clearly separates this initialization tool from the many getter/query sibling tools.

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

Usage Guidelines4/5

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

It explicitly instructs agents to call this tool first before accessing model data, which is a clear when-to-use directive. It does not name sibling tools or state when not to use it, but the setup-versus-access distinction is sufficient for a simple initializer.

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