First Session¶

This walkthrough demonstrates a complete first run in any MCP client.

Goal¶

Create a model, add zones, validate, save, reload, and inspect.

Step-by-Step Calls¶

1. Create a New Model¶

{
  "tool": "new_model",
  "arguments": {
    "version": "24.1.0"
  }
}

2. Inspect Schema Before Writing¶

{
  "tool": "describe_object_type",
  "arguments": {
    "object_type": "Zone"
  }
}

3. Add Multiple Objects Efficiently¶

{
  "tool": "batch_add_objects",
  "arguments": {
    "objects": [
      {"object_type": "Zone", "name": "Office"},
      {"object_type": "Zone", "name": "Corridor"},
      {"object_type": "Zone", "name": "Storage"}
    ]
  }
}

4. Validate¶

{
  "tool": "validate_model",
  "arguments": {
    "check_references": true
  }
}

5. Save¶

{
  "tool": "save_model",
  "arguments": {
    "file_path": "./example.idf",
    "output_format": "idf"
  }
}

6. Reload and Verify¶

{
  "tool": "load_model",
  "arguments": {
    "file_path": "./example.idf"
  }
}

Read the idfkit://model/summary resource to verify the model was loaded correctly.

Expected Outcome¶

zone_count is 3
total_objects includes your new zones
validation returns is_valid: true

Next Step: Add Simulation¶

download_weather_file(query="Chicago")
run_simulation(annual=true)
Read the idfkit://simulation/results resource