Skip to main content
Glama
idfkit

idfkit-mcp

Official
by idfkit

migrate_model

Destructive

Forward-migrate a loaded EnergyPlus model to a newer version. Replaces the in-memory document with the migrated version and records a change log for subsequent validation and saving.

Instructions

Forward-migrate the loaded model to a newer EnergyPlus version.

Drives the EnergyPlus IDFVersionUpdater transition binaries through the required chain of steps and replaces the session document with the migrated one. state.file_path is unchanged — call save_model(path=...) to persist the migrated model.

Preconditions: model loaded; target version >= current model version. Side effects: replaces the in-memory document; records a change-log entry. Next step: validate_model + check_model_integrity, then save_model.

Read idfkit://migration/report for per-step stdout/stderr and the structural diff after the call.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keep_work_dirNoRetain the per-step transition work directory for debugging.
energyplus_dirNoEnergyPlus install dir. Autodetected if None.
target_versionNoTarget EnergyPlus version "X.Y.Z". If omitted, uses the installed EnergyPlus version (the migration binaries ship with EnergyPlus, so an install is required regardless).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
diffYesStructural diff between the source and migrated documents.
stepsYes
successYes
summaryYes
source_versionYes
target_versionYes
requested_targetYes
Behavior5/5

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

Annotations (destructiveHint=true) are supplemented with detailed behavioral context: drives IDFVersionUpdater, replaces in-memory document, records changelog, and offers debugging via keep_work_dir. No contradictions.

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?

Well-structured with bullet points, front-loaded with main action. Slightly verbose but each sentence adds value. No wasted text.

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 complexity, full schema coverage, output schema present, and annotations, the description covers all critical aspects: preconditions, side effects, next steps, and report location. Highly complete.

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% with detailed descriptions. The tool description adds minimal extra meaning beyond restating schema info, so baseline 3 is appropriate.

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 forward-migrates the loaded model to a newer EnergyPlus version, using specific verb and resource. It is distinct from siblings like convert_osm_to_idf.

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?

Provides preconditions (model loaded, target version >= current), side effects (replaces in-memory document, records change-log), and next steps (validate_model, save_model). Does not explicitly compare to alternatives but context is clear.

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/idfkit/idfkit-mcp'

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