AI renovation planner: step-by-step plan, materials from room sizes, local store prices, 3D layout
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Calculates material quantities with waste allowance per room. Returns material keys and search queries in the language of the country's stores.
diy — do it yourself, pro — contractor
ISO country code
Heat source: gas — system boiler + cylinder + flue, combi — combi boiler + flue, furnace — US gas furnace + central AC + water heater, heat_pump — heat pump + cylinder, none. Omit to use the country default
Windows, pcs (for window sills)
House: attic roof area to insulate, m²
House: facade area without windows, m²
Kitchen length, running m (default 3.5)
Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it.
New sockets and switches
A new consumer unit is needed
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http remont https://remont-mcp.wrpzdm9jmt.workers.dev/mcp
Calculates material quantities with waste allowance per room. Returns material keys and search queries in the language of the country's stores.
| Argument | Type | Description |
|---|---|---|
| mode* | string | diy — do it yourself, pro — contractor |
| doors | integer | |
| rooms* | array | |
| works* | array | |
| boiler | string | Heat source: gas — system boiler + cylinder + flue, combi — combi boiler + flue, furnace — US gas furnace + central AC + water heater, heat_pump — heat pump + cylinder, none. Omit to use the country default |
| stairs | object | |
| country* | string | ISO country code |
| windows | integer | Windows, pcs (for window sills) |
| attic_m2 | number | House: attic roof area to insulate, m² |
| property | string | |
| facade_m2 | number | House: facade area without windows, m² |
| kitchen_m | number | Kitchen length, running m (default 3.5) |
| ui_locale | string | Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it. |
| new_points | integer | New sockets and switches |
| total_area_m2 | number | |
| distribution_board | boolean | A new consumer unit is needed |
{
"type": "object",
"required": [
"country",
"rooms",
"works",
"mode"
],
"properties": {
"mode": {
"enum": [
"diy",
"pro"
],
"type": "string",
"description": "diy — do it yourself, pro — contractor"
},
"doors": {
"type": "integer",
"minimum": 0
},
"rooms": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"area_m2",
"floor"
],
"properties": {
"wet": {
"type": "boolean",
"description": "Bathroom: tiles on walls and waterproofing"
},
"name": {
"type": "string"
},
"floor": {
"enum": [
"tiles",
"spc",
"none"
],
"type": "string"
},
"area_m2": {
"type": "number"
},
"width_m": {
"type": "number"
},
"height_m": {
"type": "number"
},
"length_m": {
"type": "number"
}
}
}
},
"works": {
"type": "array",
"items": {
"enum": [
"demolition",
"electrics",
"heating",
"attic",
"walls",
"bathroom",
"floors",
"kitchen",
"paint",
"doors",
"facade"
],
"type": "string"
}
},
"boiler": {
"enum": [
"gas",
"combi",
"furnace",
"heat_pump",
"none"
],
"type": "string",
"description": "Heat source: gas — system boiler + cylinder + flue, combi — combi boiler + flue, furnace — US gas furnace + central AC + water heater, heat_pump — heat pump + cylinder, none. Omit to use the country default"
},
"stairs": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"steps": {
"type": "integer"
},
"renovate": {
"type": "boolean"
}
}
},
"country": {
"type": "string",
"description": "ISO country code"
},
"windows": {
"type": "integer",
"minimum": 0,
"description": "Windows, pcs (for window sills)"
},
"attic_m2": {
"type": "number",
"description": "House: attic roof area to insulate, m²"
},
"property": {
"enum": [
"apartment",
"house"
],
"type": "string"
},
"facade_m2": {
"type": "number",
"description": "House: facade area without windows, m²"
},
"kitchen_m": {
"type": "number",
"description": "Kitchen length, running m (default 3.5)"
},
"ui_locale": {
"type": "string",
"description": "Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it."
},
"new_points": {
"type": "integer",
"minimum": 0,
"description": "New sockets and switches"
},
"total_area_m2": {
"type": "number"
},
"distribution_board": {
"type": "boolean",
"description": "A new consumer unit is needed"
}
}
}Deletes a saved plan. Only on the user's explicit request and after confirmation.
| Argument | Type | Description |
|---|---|---|
| plan_id* | string | |
| user_code* | string |
{
"type": "object",
"required": [
"user_code",
"plan_id"
],
"properties": {
"plan_id": {
"type": "string"
},
"user_code": {
"type": "string"
}
}
}Cached prices by material keys. City first, then the whole country. A price older than 1 days is marked stale — it should be re-checked.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| keys* | array | |
| country* | string |
{
"type": "object",
"required": [
"country",
"keys"
],
"properties": {
"city": {
"type": "string"
},
"keys": {
"type": "array",
"items": {
"type": "string"
}
},
"country": {
"type": "string"
}
}
}Popular materials and tools by work type for the country: the base list and specific products (brand, tier, price, link) that were already found and saved. Sorted by popularity. Use before searching prices and when the user asks to replace a material or tool.
| Argument | Type | Description |
|---|---|---|
| key | string | Material key (e.g. floor_tiles) or tool name — only options for it |
| kind | string | Only materials or only tools |
| tier | string | |
| work | string | Work type; without it — all |
| country* | string | ISO country code |
| ui_locale | string | Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it. |
{
"type": "object",
"required": [
"country"
],
"properties": {
"key": {
"type": "string",
"description": "Material key (e.g. floor_tiles) or tool name — only options for it"
},
"kind": {
"enum": [
"material",
"tool"
],
"type": "string",
"description": "Only materials or only tools"
},
"tier": {
"enum": [
"standard",
"premium",
"lux"
],
"type": "string"
},
"work": {
"enum": [
"demolition",
"electrics",
"heating",
"attic",
"walls",
"bathroom",
"floors",
"kitchen",
"paint",
"doors",
"facade"
],
"type": "string",
"description": "Work type; without it — all"
},
"country": {
"type": "string",
"description": "ISO country code"
},
"ui_locale": {
"type": "string",
"description": "Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it."
}
}
}Country profile: currency, search language, stores for price search, specialist rules. Call first.
| Argument | Type | Description |
|---|---|---|
| country* | string | ISO country code, e.g. PL, DE |
{
"type": "object",
"required": [
"country"
],
"properties": {
"country": {
"type": "string",
"description": "ISO country code, e.g. PL, DE"
}
}
}Data coverage report for countries: which reference prices, real labor rates, catalog products (with links) and store prices exist in the database, what is missing or stale. Use it to decide what to look up and save (save_catalog_items, save_prices, save_labor_rates) — e.g. when asked to fill the database for a country. Without country — a short summary for all countries.
| Argument | Type | Description |
|---|---|---|
| country | string | ISO country code; omit for all countries |
{
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "ISO country code; omit for all countries"
}
}
}Returns the floor layout of a plan (floors, rooms, walls, doors, windows, furniture in cm), the rooms derived from it (area, length × width, wet, level) for recalc_plan, and corners: the corner letters shown on the plan (room i has letters 4i..4i+3 clockwise from top-left: A B C D, E F G H…) with coordinates and side lengths, so «wall A-B of the kitchen» means the same to you and the user.
| Argument | Type | Description |
|---|---|---|
| view_id* | string |
{
"type": "object",
"required": [
"view_id"
],
"properties": {
"view_id": {
"type": "string"
}
}
}Returns the full current state of a plan as JSON: rooms (calc_input) and calculation bases, stages with tasks (done or not), who does each stage and contractor labour, materials with qty, unit, calculated qty and formula, prices, packs, store, link, selected tier/option, tools (buy/rent, owned), totals per stage and grand total with 10% reserve, plus an audit list (missing stages or prices, duplicates, suspicious quantities, old prices). Everything the user changed in the plan widget is included. Use it to check calculations, answer questions about the plan or before editing it. Pass view_id (from show_renovation_plan / open_plan) or user_code + plan_id.
| Argument | Type | Description |
|---|---|---|
| plan_id | string | |
| view_id | string | |
| user_code | string |
{
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"view_id": {
"type": "string"
},
"user_code": {
"type": "string"
}
}
}English widget texts (form and plan). Translate the values into the user's language and pass them as labels.
| Argument | Type | Description |
|---|---|---|
| locale | string | Language code you translate into (e.g. lt, fr, ja) — for statistics |
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "Language code you translate into (e.g. lt, fr, ja) — for statistics"
}
}
}Renovation stages in the right order with tasks, drying times and where a specialist is needed.
| Argument | Type | Description |
|---|---|---|
| works* | array | Which works the renovation includes |
| ui_locale | string | Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it. |
{
"type": "object",
"required": [
"works"
],
"properties": {
"works": {
"type": "array",
"items": {
"enum": [
"demolition",
"electrics",
"heating",
"attic",
"walls",
"bathroom",
"floors",
"kitchen",
"paint",
"doors",
"facade"
],
"type": "string"
},
"description": "Which works the renovation includes"
},
"ui_locale": {
"type": "string",
"description": "Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it."
}
}
}List of the user's saved plans by their personal code. Each plan has title, saved_at and (for plans saved after this field was added) country, currency, area_m2, rooms, stages, total_min/total_max (grand total incl. 10% reserve at save time). Older plans may lack these fields.
| Argument | Type | Description |
|---|---|---|
| user_code* | string | Personal code |
{
"type": "object",
"required": [
"user_code"
],
"properties": {
"user_code": {
"type": "string",
"description": "Personal code"
}
}
}Marks plan materials as bought (or un-marks them) when the user says in the chat that they bought something. The plan widget has the same 🛒 tick per material. Bought lines stay in the estimate; the plan shows «bought» and «left to buy». Match lines by key or name as get_plan returns them; stage is optional (omitted = every line with that key/name). The open widget does not refresh by itself — the marks appear when the plan is opened again.
| Argument | Type | Description |
|---|---|---|
| items* | array | |
| bought | boolean | true = bought (default), false = un-mark |
| view_id* | string | view_id of the plan |
{
"type": "object",
"required": [
"view_id",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"stage": {
"type": "string",
"description": "Exact stage name (optional)"
}
}
}
},
"bought": {
"type": "boolean",
"description": "true = bought (default), false = un-mark"
},
"view_id": {
"type": "string",
"description": "view_id of the plan"
}
}
}Opens a saved plan with ticked tasks. Ticks keep being saved on the server.
| Argument | Type | Description |
|---|---|---|
| plan_id* | string | |
| user_code* | string |
{
"type": "object",
"required": [
"user_code",
"plan_id"
],
"properties": {
"plan_id": {
"type": "string"
},
"user_code": {
"type": "string"
}
}
}Shows the user a form: apartment or house, renovation type, city, rooms, works, who does them. Call when data about the property is missing. The answers arrive in the user's next message as JSON.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| rooms | array | Rooms recognised from the user's floor plan or photos |
| floors | integer | |
| labels | object | Widget text translations for languages without a built-in translation (built in: ru, pl, en, de, uk). Keys come from get_ui_labels. |
| locale | string | Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it. |
| country | string | Country code, if known |
| height_m | number | |
| property | string | |
| total_area_m2 | number |
Call FIRST when a user message comes from a plan button: it contains [view_id: …] and asks (in the user's language) to find missing prices, refresh all prices, find options for an item, check compatibility or save the plan. Returns the item list and the exact steps.
| Argument | Type | Description |
|---|---|---|
| item | string | For options: the item name from the message |
| action* | string | |
| view_id* | string | view_id from the message |
{
"type": "object",
"required": [
"view_id",
"action"
],
"properties": {
"item": {
"type": "string",
"description": "For options: the item name from the message"
},
"action": {
"enum": [
"find_prices",
"refresh_prices",
"options",
"compatibility",
"save",
"recalc"
],
"type": "string"
},
"view_id": {
"type": "string",
"description": "view_id from the message"
}
}
}In one request: country profile (stores, rules, currency), stages with tasks and tools, material calculation by room and for every material and tool — ready products from the country catalog (by tier standard/premium/lux, with price and link). Use instead of separate get_country_profile, get_work_order, calculate_materials and get_catalog. todo lists what still has to be found in stores.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| mode | string | |
| tier | string | Default tier |
| doors | integer | |
| rooms | array | |
| works* | array | |
| boiler | string | Heat source: gas — system boiler + cylinder + flue, combi — combi boiler + flue, furnace — US gas furnace + central AC + water heater, heat_pump — heat pump + cylinder, none. Omit to use the country default |
| floors | integer | |
| stairs | object |
Sets or changes the rooms of an already shown plan — names, area_m2 or length_m × width_m, floor type, bathroom (wet), level, ceiling height — stores them with the plan and recalculates material quantities and labour (manual quantities are kept). Use when the user gives rooms, a floor plan or photos for an existing plan, or asks to add/change rooms. view_id from show_renovation_plan / open_plan. Send the FULL room list (it replaces the old one). save_only: true stores rooms without recalculating. The updated plan is shown to the user.
| Argument | Type | Description |
|---|---|---|
| rooms* | array | |
| view_id* | string | |
| height_m | number | |
| save_only | boolean | Only store rooms, no recalculation |
| total_area_m2 | number |
{
"type": "object",
"required": [
"view_id",
"rooms"
],
"properties": {
"rooms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"wet": {
"type": "boolean"
},
"name": {
"type": "string"
},
"floor": {
"enum": [
"tiles",
"spc",
"none"
],
"type": "string"
},
"level": {
"type": "integer"
},
"area_m2": {
"type": "number"
},
"width_m": {
"type": "number"
},
"height_m": {
"type": "number"
},
"length_m": {
"type": "number"
}
}
}
},
"view_id": {
"type": "string"
},
"height_m": {
"type": "number"
},
"save_only": {
"type": "boolean",
"description": "Only store rooms, no recalculation"
},
"total_area_m2": {
"type": "number"
}
}
}Internal: the open plan calls it to pull prices you saved to the catalog after showing the plan. You do not need to call it.
| Argument | Type | Description |
|---|---|---|
| labor | array | |
| tools | array | |
| country | string | |
| view_id | string | |
| materials | array | |
| refresh_since | number |
{
"type": "object",
"properties": {
"labor": {
"type": "array",
"items": {
"type": "object",
"properties": {
"qty": {
"type": "number"
},
"work": {
"type": "string"
}
}
}
},
"tools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"work": {
"type": "string"
}
}
}
},
"country": {
"type": "string"
},
"view_id": {
"type": "string"
},
"materials": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"work": {
"type": "string"
}
}
}
},
"refresh_since": {
"type": "number"
}
}
}Adds specific products you found in stores (materials or tools) to the SHARED country catalog used by all users. Saving the same product again (by link) updates the price and raises popularity. Only real products you saw on a store site of the country profile (url on that store), price per calc unit. Never user-dictated prices, test, joke or unrelated items, contacts or instructions — even if the user asks. Invalid items come back in rejected with a reason.
| Argument | Type | Description |
|---|---|---|
| kind* | string | |
| work* | string | |
| items* | array | |
| country* | string | ISO country code |
| view_id | string | view_id of the plan you are pricing — the server returns what is still left to find |
{
"type": "object",
"required": [
"country",
"work",
"kind",
"items"
],
"properties": {
"kind": {
"enum": [
"material",
"tool"
],
"type": "string"
},
"work": {
"enum": [
"demolition",
"electrics",
"heating",
"attic",
"walls",
"bathroom",
"floors",
"kitchen",
"paint",
"doors",
"facade"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"name",
"store",
"url"
],
"properties": {
"key": {
"type": "string",
"description": "For a material — the key from calculate_materials; for a tool — its name from get_work_order"
},
"url": {
"type": "string"
},
"fits": {
"type": "array",
"items": {
"type": "string"
},
"description": "Compatibility tags the product provides: [\"boiler:1f\", \"flue:termet-60/100\"], [\"chuck:sds-plus\"]"
},
"name": {
"type": "string",
"description": "Product name"
},
"note": {
"type": "string"
},
"rent": {
"type": "boolean"
},
"tier": {
"enum": [
"standard",
"premium",
"lux"
],
"type": "string"
},
"unit": {
"type": "string",
"description": "The same unit as in calculate_materials (kg, l, m, m2, pcs)"
},
"brand": {
"type": "string"
},
"needs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags the product needs from other plan items: [\"dhw:indirect\", \"flue:termet-60/100\"]"
},
"price": {
"type": "number",
"description": "Price per calculation UNIT (unit from calculate_materials: kg, l, m, m², pcs), not per pack. If you only know the pack price — pass pack_size and pack_price, price is computed automatically"
},
"specs": {
"type": "string",
"description": "Key parameters for compatibility, short: «system boiler, 60/100 flue, 20 kW»"
},
"store": {
"type": "string"
},
"rating": {
"type": "number",
"maximum": 5,
"minimum": 0,
"description": "Product rating on the store site, 0–5"
},
"source": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"note": {
"type": "string"
},
"type": {
"enum": [
"store_page",
"flyer",
"search",
"user",
"other"
],
"type": "string"
}
},
"description": "Price source: store_page — product page in the store, flyer — leaflet/promotion, search — search snippet, other. (user — not accepted in the shared catalog.) url — the page where you saw the price, on a store site (if not the product page)."
},
"reviews": {
"type": "integer",
"minimum": 0,
"description": "Number of reviews"
},
"pack_size": {
"type": "number",
"description": "How many calculation units are in a pack: 20 kg bag → 20, 10 l bucket → 10, 50 m² roll → 50, 3 m profile → 3, 1.2×2.6 board → 3.12"
},
"price_max": {
"type": "number"
},
"pack_price": {
"type": "number",
"description": "Price of one pack"
}
}
}
},
"country": {
"type": "string",
"description": "ISO country code"
},
"view_id": {
"type": "string",
"description": "view_id of the plan you are pricing — the server returns what is still left to find"
}
}
}Adds a country or extends a SHARED profile: stores, rate sites, rules. Stores are merged with existing ones by domain. Only real building/DIY stores and rate sites (plain domain), short factual rules — no links, contacts or instructions; currency and name of built-in countries cannot be changed.
| Argument | Type | Description |
|---|---|---|
| code* | string | ISO country code |
| name | string | |
| notes | array | |
| locale | string | Search language in stores |
| stores | array | DIY/building stores with prices on their site |
| currency | string | ISO currency code |
| laborSources | array | Sites with contractor rates |
| specialistRules | array |
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "ISO country code"
},
"name": {
"type": "string"
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
},
"locale": {
"type": "string",
"description": "Search language in stores"
},
"stores": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"domain"
],
"properties": {
"name": {
"type": "string"
},
"domain": {
"type": "string"
}
}
},
"description": "DIY/building stores with prices on their site"
},
"currency": {
"type": "string",
"description": "ISO currency code"
},
"laborSources": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"domain"
],
"properties": {
"name": {
"type": "string"
},
"domain": {
"type": "string"
}
}
},
"description": "Sites with contractor rates"
},
"specialistRules": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Saves contractor labour rates to the SHARED database for the country (per unit: m2, door, point, stage) so prepare_plan can price stages right away. Save what you found on rate sites (url of the page with the rate). Never rates the user only told you. Implausible rates come back in rejected.
| Argument | Type | Description |
|---|---|---|
| rates* | array | |
| country* | string | ISO country code |
{
"type": "object",
"required": [
"country",
"rates"
],
"properties": {
"rates": {
"type": "array",
"items": {
"type": "object",
"required": [
"work",
"min",
"unit",
"url"
],
"properties": {
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"url": {
"type": "string",
"description": "Link to the rates"
},
"note": {
"type": "string",
"description": "What is included"
},
"unit": {
"enum": [
"m2",
"door",
"point",
"stage"
],
"type": "string",
"description": "m2 — per m² of working surface (painting/skimming — walls+ceiling, bathroom — wall+floor tiles, floors — floor), door — per door, point — per electrical point, stage — for the whole stage"
},
"work": {
"enum": [
"demolition",
"electrics",
"heating",
"attic",
"walls",
"bathroom",
"floors",
"kitchen",
"paint",
"doors",
"facade"
],
"type": "string"
},
"source": {
"type": "string",
"description": "Site name"
}
}
}
},
"country": {
"type": "string",
"description": "ISO country code"
}
}
}Saves the floor layout of a plan (shown in the plan's 🏠 Layout tab, where the user drags furniture). Coordinates in cm from the top-left inner corner of each floor; x to the right, y down. Per floor: name, W, H (inner size), height_cm (ceiling), rooms [{name, label (area text), x, y, w, h, wet, block (stairs/technical, not a room), finish tiles|spc|none}], walls [{x,y,w,h}] (inner walls as rectangles), doors [{x,y,len,v,hinge,swing,open}] (v: true = in a vertical wall, opening runs down from y; false = horizontal wall, runs right from x; hinge "start" (default, at x,y) or "end"; swing 1 = opens toward +x/+y, -1 = toward -x/-y; open false = shown closed; the user edits these in the widget), windows [{x,y,len,v,label,sill_cm,height_cm}] on the outer edge (x=0 / x=W / y=0 / y=H), fixed [{name,x,y,w,h}] (stairs, shower), furniture [{name,x,y,w,h,height_cm,elev_cm,kind,type}] (type = 3D/2D model id: sofa, sofa_corner, armchair, coffee_table, tv_stand, table, chair, kitchen, island, bed, nightstand, wardrobe, dresser, desk, shelf, toilet, sink, bathtub, shower, fridge, washer, dryer, dishwasher, oven, hob, hood, microwave, boiler, water_heater, tv, ac, radiator, towel_radiator, robot; omitted = guessed from the name; the back of the model faces the nearest wall) — furniture and appliances in one list: kind "appliance" for equipment (fridge, washer, dishwasher, oven, hob, hood, boiler, water heater, TV, air conditioner, radiator), height_cm = the item's own height, elev_cm = how high it is mounted above the floor (wall TV ≈100, boiler ≈120, hood ≈150, AC ≈220, hob on the counter 90); give height_cm for every item. presets [{name, items:[same fields]}] (ready furniture variants). Build it from a drawing or photos of the floor plan; names in the user's language. Merging: floors are matched by position (or index); a floor you send replaces the fields you give, other fields and floors stay — so to move furniture send only [{index, furniture}]. replace: true replaces the whole layout. The open plan picks it up within a minute. Returns rooms derived from the layout — pass them to recalc_plan if the user wants materials recalculated from the layout.
| Argument | Type | Description |
|---|---|---|
| layout* | object |
Internal: the plan widget saves furniture moved by the user. You do not need to call it.
| Argument | Type | Description |
|---|---|---|
| rev | number | |
| doors | array | |
| floor* | number | |
| presets | array | |
| view_id* | string | |
| furniture* | array |
{
"type": "object",
"required": [
"view_id",
"floor",
"furniture"
],
"properties": {
"rev": {
"type": "number"
},
"doors": {
"type": "array",
"items": {
"type": "object"
}
},
"floor": {
"type": "number"
},
"presets": {
"type": "array",
"items": {
"type": "object"
}
},
"view_id": {
"type": "string"
},
"furniture": {
"type": "array",
"items": {
"type": "object"
}
}
}
}Saves the plan on the server, only if the user asked to save it. Without user_code it creates a new personal code and returns it — show the code to the user and ask them to write it down: with it they can open their plans in any chat. Nobody else needs the code and it cannot be recovered.
| Argument | Type | Description |
|---|---|---|
| plan* | object | The same object you pass to show_renovation_plan (title, locale, currency, mode, stages, materials, notes…) |
| plan_id | string | If you are updating an already saved plan |
| view_id | string | view_id of the shown plan — then line edits and checklist ticks are saved too, and the open plan remembers the code |
| user_code | string | User's personal code if they already have one, e.g. oak-river-moon-4821 |
{
"type": "object",
"required": [
"plan"
],
"properties": {
"plan": {
"type": "object",
"description": "The same object you pass to show_renovation_plan (title, locale, currency, mode, stages, materials, notes…)",
"additionalProperties": true
},
"plan_id": {
"type": "string",
"description": "If you are updating an already saved plan"
},
"view_id": {
"type": "string",
"description": "view_id of the shown plan — then line edits and checklist ticks are saved too, and the open plan remembers the code"
},
"user_code": {
"type": "string",
"description": "User's personal code if they already have one, e.g. oak-river-moon-4821"
}
}
}Saves the user's preferences under their personal code so they are selected by default in every new plan: tools they own and preferred non-consumable products (e.g. a tile brand, a specific boiler, a tap). Call when the user says what they own or which product they always want. Ticking 'have' and choosing an option in a saved plan updates preferences automatically. With no changes it just returns the current preferences.
| Argument | Type | Description |
|---|---|---|
| forget | array | Material keys to forget |
| materials | object | Preferred product per material key (non-consumables), e.g. {"floor_tiles": {name, price, store, url, country}} |
| user_code* | string | Personal code |
| tools_have | array | Tool names the user owns (add) |
| tools_remove | array | Tool names to remove from owned |
{
"type": "object",
"required": [
"user_code"
],
"properties": {
"forget": {
"type": "array",
"items": {
"type": "string"
},
"description": "Material keys to forget"
},
"materials": {
"type": "object",
"description": "Preferred product per material key (non-consumables), e.g. {\"floor_tiles\": {name, price, store, url, country}}",
"additionalProperties": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"tier": {
"type": "string"
},
"brand": {
"type": "string"
},
"price": {
"type": "number"
},
"store": {
"type": "string"
},
"country": {
"type": "string"
},
"price_max": {
"type": "number"
}
}
}
},
"user_code": {
"type": "string",
"description": "Personal code"
},
"tools_have": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tool names the user owns (add)"
},
"tools_remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tool names to remove from owned"
}
}
}Saves prices found in stores to the SHARED price cache (used by all users). Only prices you saw on a store site of the country profile, with the product url; price per material unit from calculate_materials, in the country's currency. Never prices the user only told you. Invalid items come back in rejected with a reason.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| prices* | array | |
| country* | string |
{
"type": "object",
"required": [
"country",
"prices"
],
"properties": {
"city": {
"type": "string"
},
"prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"store",
"price",
"unit"
],
"properties": {
"ean": {
"type": "string"
},
"key": {
"type": "string"
},
"url": {
"type": "string"
},
"unit": {
"type": "string"
},
"price": {
"type": "number"
},
"store": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"note": {
"type": "string"
},
"type": {
"enum": [
"store_page",
"flyer",
"search",
"user",
"other"
],
"type": "string"
}
},
"description": "Price source: type store_page|flyer|search|user|other, url, note"
}
}
}
},
"country": {
"type": "string"
}
}
}Saves ticked tasks of the plan. Called by the plan widget.
| Argument | Type | Description |
|---|---|---|
| who | object | |
| have | object | |
| tiers | object | |
| bought | object | |
| checks* | object | |
| plan_id* | string | |
| user_code* | string |
{
"type": "object",
"required": [
"user_code",
"plan_id",
"checks"
],
"properties": {
"who": {
"type": "object",
"additionalProperties": {
"enum": [
"diy",
"pro"
],
"type": "string"
}
},
"have": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"tiers": {
"type": "object",
"additionalProperties": {
"enum": [
"standard",
"premium",
"lux"
],
"type": "string"
}
},
"bought": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"checks": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"plan_id": {
"type": "string"
},
"user_code": {
"type": "string"
}
}
}Internal: the open plan saves checklist ticks and switches. You do not need to call it.
| Argument | Type | Description |
|---|---|---|
| who | object | |
| have | object | |
| tiers | object | |
| tmode | object | |
| bought | object | |
| checks | object | |
| choice | object | |
| view_id* | string |
{
"type": "object",
"required": [
"view_id"
],
"properties": {
"who": {
"type": "object"
},
"have": {
"type": "object"
},
"tiers": {
"type": "object"
},
"tmode": {
"type": "object"
},
"bought": {
"type": "object"
},
"checks": {
"type": "object"
},
"choice": {
"type": "object"
},
"view_id": {
"type": "string"
}
}
}Shows the user an interactive plan: stages with a checklist and a materials table with the estimate. All texts in the user's language.
| Argument | Type | Description |
|---|---|---|
| mode | string | Who does the work |
| notes | array | |
| rooms | array | Rooms (name, area_m2, length_m, width_m, floor, wet) if you have no calc_input |
| title* | string | |
| tools | array | Tools for DIY work, by stage |
| labels | object | Widget text translations for languages without a built-in translation (built in: ru, pl, en, de, uk). Keys come from get_ui_labels. |
| locale* | string | Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it. |
| stages* | array | |
| country | string |
Changes an already shown plan without showing it again: replace a material or tool, set brand/price/link/quantity, add or remove a line, add a stage or items to a stage, rename. The open plan updates itself within seconds; a saved plan (save_plan) is updated too. view_id comes from the show_renovation_plan response.
| Argument | Type | Description |
|---|---|---|
| changes* | array | |
| view_id* | string | view_id from the show_renovation_plan response |
{
"type": "object",
"required": [
"view_id",
"changes"
],
"properties": {
"changes": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind"
],
"properties": {
"add": {
"type": "boolean",
"description": "Add a new line / stage / task"
},
"key": {
"type": "string",
"description": "Material key, exact tool name or key of a new stage"
},
"set": {
"type": "object",
"description": "New fields: name, brand, qty, unit, price_min, price_max, store, url, rent, tier (change only this tier), labor_min, labor_max, wait…",
"additionalProperties": true
},
"kind": {
"enum": [
"material",
"tool",
"stage",
"task"
],
"type": "string"
},
"name": {
"type": "string",
"description": "Current name of the line or task (for lookup), or the name of a new one"
},
"stage": {
"type": "string",
"description": "Stage key or name (for material/tool/task — where to look for the line)"
},
"remove": {
"type": "boolean",
"description": "Remove a line / stage / task"
}
}
}
},
"view_id": {
"type": "string",
"description": "view_id from the show_renovation_plan response"
}
}
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 21, 2026.
{
"type": "object",
"properties": {
"city": {
"type": "string"
},
"rooms": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"area_m2"
],
"properties": {
"wet": {
"type": "boolean"
},
"name": {
"type": "string"
},
"floor": {
"enum": [
"tiles",
"spc",
"none"
],
"type": "string"
},
"area_m2": {
"type": "number"
}
}
},
"description": "Rooms recognised from the user's floor plan or photos"
},
"floors": {
"type": "integer",
"minimum": 1
},
"labels": {
"type": "object",
"description": "Widget text translations for languages without a built-in translation (built in: ru, pl, en, de, uk). Keys come from get_ui_labels.",
"additionalProperties": true
},
"locale": {
"type": "string",
"description": "Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it."
},
"country": {
"type": "string",
"description": "Country code, if known"
},
"height_m": {
"type": "number"
},
"property": {
"enum": [
"apartment",
"house"
],
"type": "string"
},
"total_area_m2": {
"type": "number"
}
}
}| country* | string | ISO country code |
| windows | integer | Windows, pcs (for window sills) |
| attic_m2 | number |
| height_m | number | Ceiling height, m (default for rooms) |
| property | string |
| facade_m2 | number |
| kitchen_m | number | Kitchen length, running m (default 3.5) |
| ui_locale | string | Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it. |
| user_code | string | User's personal code, if known — applies their saved preferences (owned tools, preferred products) by default |
| new_points | integer |
| total_area_m2 | number |
| distribution_board | boolean | A new consumer unit is needed |
{
"type": "object",
"required": [
"country",
"works"
],
"properties": {
"city": {
"type": "string"
},
"mode": {
"enum": [
"diy",
"pro"
],
"type": "string"
},
"tier": {
"enum": [
"standard",
"premium",
"lux"
],
"type": "string",
"description": "Default tier"
},
"doors": {
"type": "integer",
"minimum": 0
},
"rooms": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"area_m2",
"floor"
],
"properties": {
"wet": {
"type": "boolean"
},
"name": {
"type": "string",
"description": "Room name in the user's language"
},
"floor": {
"enum": [
"tiles",
"spc",
"none"
],
"type": "string"
},
"level": {
"type": "integer",
"description": "Floor (for a house)"
},
"area_m2": {
"type": "number"
},
"width_m": {
"type": "number"
},
"height_m": {
"type": "number"
},
"length_m": {
"type": "number"
}
}
}
},
"works": {
"type": "array",
"items": {
"enum": [
"demolition",
"electrics",
"heating",
"attic",
"walls",
"bathroom",
"floors",
"kitchen",
"paint",
"doors",
"facade"
],
"type": "string"
}
},
"boiler": {
"enum": [
"gas",
"combi",
"furnace",
"heat_pump",
"none"
],
"type": "string",
"description": "Heat source: gas — system boiler + cylinder + flue, combi — combi boiler + flue, furnace — US gas furnace + central AC + water heater, heat_pump — heat pump + cylinder, none. Omit to use the country default"
},
"floors": {
"type": "integer"
},
"stairs": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"steps": {
"type": "integer"
},
"renovate": {
"type": "boolean"
}
}
},
"country": {
"type": "string",
"description": "ISO country code"
},
"windows": {
"type": "integer",
"minimum": 0,
"description": "Windows, pcs (for window sills)"
},
"attic_m2": {
"type": "number"
},
"height_m": {
"type": "number",
"description": "Ceiling height, m (default for rooms)"
},
"property": {
"enum": [
"apartment",
"house"
],
"type": "string"
},
"facade_m2": {
"type": "number"
},
"kitchen_m": {
"type": "number",
"description": "Kitchen length, running m (default 3.5)"
},
"ui_locale": {
"type": "string",
"description": "Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it."
},
"user_code": {
"type": "string",
"description": "User's personal code, if known — applies their saved preferences (owned tools, preferred products) by default"
},
"new_points": {
"type": "integer",
"minimum": 0
},
"total_area_m2": {
"type": "number"
},
"distribution_board": {
"type": "boolean",
"description": "A new consumer unit is needed"
}
}
}| replace | boolean |
| view_id* | string |
{
"type": "object",
"required": [
"view_id",
"layout"
],
"properties": {
"layout": {
"type": "object",
"properties": {
"floors": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"replace": {
"type": "boolean"
},
"view_id": {
"type": "string"
}
}
}| ISO country code — needed so the plan can fill in prices itself |
| view_id | string | Only if you re-show the same plan |
| currency* | string | ISO currency code, e.g. PLN |
| materials* | array |
| user_code | string | User's personal code, if known — applies saved preferences by default |
| calc_input | object | calc_input from prepare_plan, unchanged — REQUIRED for the rooms editor: rooms, sizes and ceiling height are stored with the plan |
| default_tier | string | Tier selected by default for all stages |
| prices_checked_at | string |
{
"type": "object",
"required": [
"title",
"locale",
"currency",
"stages",
"materials"
],
"properties": {
"mode": {
"enum": [
"diy",
"pro"
],
"type": "string",
"description": "Who does the work"
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
},
"rooms": {
"type": "array",
"items": {
"type": "object"
},
"description": "Rooms (name, area_m2, length_m, width_m, floor, wet) if you have no calc_input"
},
"title": {
"type": "string"
},
"tools": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"key": {
"type": "string",
"description": "Tool key = the tool name exactly as prepare_plan / get_work_order gave it — keep it when you translate name"
},
"url": {
"type": "string"
},
"have": {
"type": "boolean",
"description": "The user said they already have it"
},
"name": {
"type": "string"
},
"note": {
"type": "string"
},
"rent": {
"type": "boolean",
"description": "Rental price, not purchase"
},
"stage": {
"type": "string",
"description": "Exact stage name"
},
"store": {
"type": "string"
},
"price_max": {
"type": "number"
},
"price_min": {
"type": "number"
}
}
},
"description": "Tools for DIY work, by stage"
},
"labels": {
"type": "object",
"description": "Widget text translations for languages without a built-in translation (built in: ru, pl, en, de, uk). Keys come from get_ui_labels.",
"additionalProperties": true
},
"locale": {
"type": "string",
"description": "Language of the user's messages (not of the country), any code: en, ru, pl, uk, de, fr, es… Always pass it."
},
"stages": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"tasks"
],
"properties": {
"key": {
"type": "string",
"description": "Stage key from prepare_plan / get_work_order (electrics, walls, bathroom…) — keep it when you translate the name"
},
"who": {
"enum": [
"diy",
"pro"
],
"type": "string",
"description": "Who does the stage: diy — DIY, pro — contractor. The plan has a switch"
},
"name": {
"type": "string"
},
"tasks": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"wait": {
"type": "string"
}
}
}
},
"labor_max": {
"type": "number",
"description": "Contractor labour cost for the whole stage, to"
},
"labor_min": {
"type": "number",
"description": "Contractor labour cost for the whole stage, from"
},
"labor_url": {
"type": "string",
"description": "Link to the rates"
},
"labor_note": {
"type": "string",
"description": "How it was calculated, e.g. 45 zł/m² × 120 m²"
},
"specialist": {
"type": "boolean"
},
"labor_source": {
"type": "string",
"description": "Name of the site with rates"
},
"labor_req_max": {
"type": "number"
},
"labor_req_min": {
"type": "number",
"description": "Mandatory contractor work paid even when DIY (measurements, plumber check, boiler service), from"
},
"labor_req_note": {
"type": "string"
}
}
}
},
"country": {
"type": "string",
"description": "ISO country code — needed so the plan can fill in prices itself"
},
"view_id": {
"type": "string",
"description": "Only if you re-show the same plan"
},
"currency": {
"type": "string",
"description": "ISO currency code, e.g. PLN"
},
"materials": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"qty",
"unit"
],
"properties": {
"key": {
"type": "string",
"description": "Material key from prepare_plan (floor_tiles, grout…) — ALWAYS keep it, also when you rename the line to a store name: prices, catalog and recalc find the line by key"
},
"qty": {
"type": "number"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"unit": {
"type": "string"
},
"stage": {
"type": "string",
"description": "Exact stage name from stages"
},
"store": {
"type": "string"
},
"tiers": {
"type": "object",
"properties": {
"lux": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"store": {
"type": "string"
},
"pack_size": {
"type": "number",
"description": "If sold in packs: pack_size — how many calculation units (kg, l, m, m²) are in a pack, pack_price — price of a pack. The plan counts whole packs."
},
"price_max": {
"type": "number"
},
"price_min": {
"type": "number"
},
"pack_price": {
"type": "number"
}
}
},
"premium": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"store": {
"type": "string"
},
"pack_size": {
"type": "number",
"description": "If sold in packs: pack_size — how many calculation units (kg, l, m, m²) are in a pack, pack_price — price of a pack. The plan counts whole packs."
},
"price_max": {
"type": "number"
},
"price_min": {
"type": "number"
},
"pack_price": {
"type": "number"
}
}
},
"standard": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"store": {
"type": "string"
},
"pack_size": {
"type": "number",
"description": "If sold in packs: pack_size — how many calculation units (kg, l, m, m²) are in a pack, pack_price — price of a pack. The plan counts whole packs."
},
"price_max": {
"type": "number"
},
"price_min": {
"type": "number"
},
"pack_price": {
"type": "number"
}
}
}
},
"description": "Options by tier: standard, premium, lux. Each — { name, price_min, price_max, store, url }. Option fields replace the main ones when the tier is selected in the plan."
},
"pack_size": {
"type": "number",
"description": "If sold in packs: pack_size — how many calculation units (kg, l, m, m²) are in a pack, pack_price — price of a pack. The plan counts whole packs."
},
"price_max": {
"type": "number"
},
"price_min": {
"type": "number",
"description": "Price per UNIT (per kg, l, m, m²), not per pack"
},
"pack_price": {
"type": "number"
}
}
}
},
"user_code": {
"type": "string",
"description": "User's personal code, if known — applies saved preferences by default"
},
"calc_input": {
"type": "object",
"description": "calc_input from prepare_plan, unchanged — REQUIRED for the rooms editor: rooms, sizes and ceiling height are stored with the plan",
"additionalProperties": true
},
"default_tier": {
"enum": [
"standard",
"premium",
"lux"
],
"type": "string",
"description": "Tier selected by default for all stages"
},
"prices_checked_at": {
"type": "string"
}
}
}