Floorplan

Create a FLOOR PLAN — a top-down spatial layout of a building or space: rooms (axis-aligned rectangles sharing walls), doors, windows, furniture stamps from a fixed catalog, and short text labels,…

Updated 18 Sep 20263 min read

Send "type": "floorplan".

Also available as the MCP tool render_floorplan. The same payload works through either surface.

Fields

data

titlestring

Short name of the plan (e.g. "Two-bedroom Apartment") — displayed as the frame title

planTypeenum<string>

Kind of space the plan describes. One of apartment, house, office, retail, event or other.

themeenum<string>

Drawing style the plan is rendered in; follow the style the user asked for, otherwise pick the one that suits the space. One of soft, blueprint or marker.

roomsobject[]required

Axis-aligned rectangular rooms in grid units (1 unit = 0.5 m) that tile the outline with shared walls and never overlap

Child attributes

idstringrequired

Unique id, "r1", "r2", …

labelstringrequired

Room name shown in the room (e.g. "Bedroom 1")

typeenum<string>required

Room type; drives the theme colour. One of living, bedroom, kitchen, dining, bath, office, hall, storage, outdoor or other.

xnumberrequired

Left edge in grid units (integer or .5)

ynumberrequired

Top edge in grid units (integer or .5); y grows down

wnumberrequired

Width in grid units (> 0)

hnumberrequired

Height in grid units (> 0)

itemsobject[]

Furniture, door and window stamps from the fixed catalog

Child attributes

idstringrequired

Unique id, "i1", "i2", …

assetenum<string>required

Catalog key — see the asset catalog for footprints

xnumberrequired

Furniture: top-left x inside a room. Door/window: start point x on the wall line

ynumberrequired

Furniture: top-left y inside a room. Door/window: start point y on the wall line

renum<number>

Rotation in degrees; for doors/windows 0 = horizontal wall (runs +x), 90 = vertical wall (runs +y). One of 0, 90, 180 or 270.

wnumber

Optional own width in grid units when this piece should differ from the catalog footprint (multiples of 0.25, at least half the catalog side, at most three times it or 8 units, whichever is larger; keys marked keeps proportions stay within half to one and a half times); for doors/windows this is the length along the wall

hnumber

Optional own height in grid units, same rules as w; ignored for doors/windows and for keys marked "keeps proportions"

labelsobject[]

Optional short text notes placed at free points

Child attributes

idstringrequired

Unique id, "l1", "l2", …

textstringrequired

Note text (a few words)

xnumberrequired

x in grid units

ynumberrequired

y in grid units

Example

{
  "type": "floorplan",
  "data": {
    "title": "Q4 Launch Planning",
    "planType": "apartment",
    "theme": "soft",
    "rooms": [
      {
        "id": "string",
        "label": "string",
        "type": "living",
        "x": 0,
        "y": 0,
        "w": 0,
        "h": 0
      }
    ],
    "items": [
      {
        "id": "string",
        "asset": "sofa-2seat",
        "x": 0,
        "y": 0,
        "r": 0,
        "w": 0,
        "h": 0
      }
    ],
    "labels": [
      {
        "id": "string",
        "text": "Interview 5 users",
        "x": 0,
        "y": 0
      }
    ]
  }
}

Was this page helpful?