Compare upgrade options side by side
compare_plansPrice 2 to 5 options (sets of upgrades) for the SAME building on the same basis and return them side by side: cost, incentives counted, net upfront, annual benefit, yearly loss avoided, payback, net over the horizon. Our recommended plan is added as an extra option unless include_recommended is false. One estimate per option, each billed as one request. Never add an incentive whose counts_toward_roi is false (paused, waitlisted, closed) or that is contingent or competitive into any total; show every stated condition beside its incentive; name incentives by their ref (e.g. US12c). Amounts are guidance to be confirmed with the grantor.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"country": "<country>",
"segment": "<segment>",
"options": "<options>"
},
"name": "compare_plans"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | No | Street address. Per-address hazards in US, UK, DE, FR and CH; omit it to price on country averages (the reply says which). | |
| country | Yes | ISO country code: US, UK, DE, FR, CH, IT, ES … | |
| options | Yes | ||
| segment | Yes | ||
| utility | No | Electric utility name, where a programme depends on it. | |
| building | No | The building. Commercial: type (office, warehouse, retail, hotel, manufacturing, school, hospital, multifamily, data_centre …), size (small|medium|large), floor_area (sq ft in the US, m² elsewhere), owns (false for a tenant), org_type, storeys, annual_revenue (its own; else a default for the type, flagged in estimate.assumptions), installed_upgrades (ids it already has), flood_insurance (nfip|none|unknown). Residential: residential_type, tenure (own|rent|building), dwelling_units (1 for a house), foundation (slab|basement|crawlspace|pier|piling). Omitted fields use sourced defaults or public records for the address, and the reply says which. | |
| home_value | No | Residential: the home's value. Omit it and the address region's median is used (US: ACS by state), flagged in estimate.home_value as estimated. | |
| horizon_years | No | Default 10. | |
| household_size | No | ||
| household_income | No | Residential, optional. Omitted = the top income band (no income-tied money is counted on a guess). | |
| discount_rate_pct | No | ||
| include_recommended | No | Add our recommended plan as an option. Default true. | |
| planned_install_date | No | YYYY-MM-DD. Decides which programmes are open. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| options | Yes |