FloorGen
Draw, edit, check and render 2D/3D floor plans from Claude, ChatGPT or Cursor: walls, rooms, doors, windows, furniture and stairs, with building-code checks and PDF, DXF and glTF export. Remote server, sign in with a free FloorGen account.
Hosted MCP Server
npx add-mcp 'https://floorgen.app/mcp'Installs into Claude Code, Codex, Cursor and more
Documentation
What the server does
An MCP client calls tools such as create_project, add_walls, add_opening and place_item to build a real plan: walls with lengths, rooms that close, doors in walls. The plan is an ordinary FloorGen project, so you can open it in the editor, change it by hand and hand it back. Edits an agent makes appear in an open editor within about a second, each as one undoable step, and are listed under Activity.
| Item | Detail |
|---|---|
| Endpoint | POST https://floorgen.app/mcp |
| Transport | Streamable HTTP, stateless |
| Protocol versions | 2025-03-26, 2025-06-18, 2025-11-25 and 2026-07-28 |
| OAuth | OAuth 2.1 with PKCE (S256), dynamic client registration or client metadata documents, rotating refresh tokens |
| API keys | Made in Agents & MCP, start with fg_live_, shown once; sent as Authorization: Bearer <key> |
| Account | A free FloorGen account (sign in with Google); projects must be synced to it |
Connecting a client
Clients that take only a URL (claude.ai, Claude Desktop's connector screen, ChatGPT) sign you in with OAuth: you sign in to FloorGen and pick the access level on a consent page. Clients that let you set a header (Claude Code, Cursor, VS Code and most editors) use an API key, sent as Authorization: Bearer <key>. Keys are made on FloorGen's Home screen, under Agents & MCP at the foot of the sidebar: pick Read only, Read & edit or Full, all projects or chosen ones, and an expiry. Either way you need a free FloorGen account, and only projects synced to it are visible.
Claude (claude.ai, Desktop and mobile)
- Open FloorGen in the Claude directory and add it.
- Sign in to FloorGen and choose Read only, Read & edit, or Full.
- In a chat, turn FloorGen on from the tools menu. A connector added on claude.ai also appears in Claude Desktop and the mobile apps.
The directory connector lists the core tools. For all tools, or for testing, add FloorGen as a custom connector instead: Settings → Connectors → Add custom connector, name it FloorGen and paste https://floorgen.app/mcp?toolsets=all (or the toolsets you want) as the remote MCP server URL.
Claude Code
export FLOORGEN_API_KEY="fg_live_PASTE_YOUR_KEY"
claude mcp add --transport http --scope user floorgen https://floorgen.app/mcp \
--header "Authorization: Bearer $FLOORGEN_API_KEY"
Check it with claude mcp list, or /mcp inside a session.
ChatGPT
- Turn on developer mode: Settings → Apps & Connectors → Advanced settings → Developer mode. Write tools need it.
- Create a connector named FloorGen with the MCP server URL
https://floorgen.app/mcpand OAuth authentication. - Sign in to FloorGen when asked, pick the access level, then choose the connector in a chat and ask it to list your FloorGen projects.
Cursor
{
"mcpServers": {
"floorgen": {
"url": "https://floorgen.app/mcp",
"headers": { "Authorization": "Bearer ${env:FLOORGEN_API_KEY}" }
}
}
}
In Cursor Settings → MCP, floorgen shows a green dot and its tool count. The Agents & MCP dialog has set-up text for each client (Claude Code, Claude Desktop, claude.ai, Cursor, VS Code with Copilot, Windsurf, Codex CLI, Gemini CLI, Cline, ChatGPT and any other), with a new key filled in. The longer walk-through, with Claude Desktop's config file, is connecting Claude, ChatGPT and Cursor to FloorGen.
Toolsets
A short tool list helps a model choose well, so the server lists only core (60 tools) unless the client asks for more, with ?toolsets= on the URL or an X-FloorGen-Toolsets header: https://floorgen.app/mcp?toolsets=core,stairs,history, or ?toolsets=all for all 211. Claude's directory connector uses the default. A credential only ever sees the tools its access level allows: a read-only key never sees an edit tool.
| Toolset | Tools | What it adds |
|---|---|---|
core | 60 | On by default: reading, projects, floors, walls, rooms, openings, furniture, batches, checks, renders, 3D models, undo. |
more | 104 | The rest of the everyday editing: finishes, surfaces, notes, elevations, schedules, scenarios, comparisons, electrical and lighting. |
stairs | 8 | Stairs, stair cores and lifts, with their presets and checks. |
trace | 4 | A background image to trace over, and its scale; DXF import. |
live | 11 | The open editor tab: selection, view, camera. |
macros | 17 | Whole floors, layouts and rooms in one call, rooms written as plan text, and the kitchen, bathroom and living room generators. |
history | 7 | The change log, diffs, redo, checkpoints and the activity feed. |
All 211 tools
Grouped by what they work on. Lengths are in centimetres, or text such as 3.5m or 12'6"; every edit takes dry_run and expected_rev. "Edit" tools need Read & edit access, "Delete" tools Full access and a confirmation token.
Reading the plan
Start here: what the server allows, how-to answers from the help centre, and the plan as rows an agent can search.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
get_context | Returns what this FloorGen server speaks and allows. | Read | core |
get_credits | Returns the signed-in user's AI credits. | Read | core |
describe_project | A readable summary of the project. | Read | core |
list_entities | Rows for the plan's entities (and the project's section lines), filtered by type, room, box, ids (a {"tx"} selector lists what a change made) or category (items). | Read | core |
get_entity | One entity by id with its derived facts. | Read | core |
find | Finds entities from a plain-words query and ranks them. | Read | core |
get_limits | Every limit the project meets with how much is used. | Read | core |
search_help | How-to answers about using FloorGen itself (snapping, uploading a PDF, sharing, embedding, guest chats, opening a plan) from the help centre. | Read | core |
The open editor tab
Work with what the person sees in the browser right now (toolset live).
| Tool | What it does | Access | Toolset |
|---|---|---|---|
get_selection | What the person has selected in the open editor tab. | Read | live |
set_selection | Selects things in the open editor tab (they highlight; ids [] clears). | Edit | live |
get_view | How the open editor tab is showing the project. | Read | live |
set_view | Changes what the open editor tab shows. | Edit | live |
set_display | Switches what the open editor tab draws on the 2D plan, like the View menu. | Edit | live |
set_camera | Moves the 3D camera and sets the 3D switches in the open editor tab (it opens the 3D view if needed). | Edit | live |
focus_entities | Moves the open editor tab's camera to frame the given entities, so the person looks at them (in 2D it pans and zooms the plan). | Edit | live |
export_drawing | Prepares a file in the editor and posts it in the chat with Download. | Edit | live |
create_tour | Guided video tour of rooms in order, through their doors at eye height. | Edit | live |
ui_action | Does an app action in the person's editor instead of describing clicks. | Edit | live |
Projects and settings
Create, copy, import, export and delete projects; units, code profile and title block.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
list_projects | Lists the projects in this account. | Read | core |
list_templates | Lists the ready-made plans create_project and apply_template (toolset macros) use. | Read | core |
create_project | Creates a new project. | Edit | core |
rename_project | Renames the project, replacing its current name. | Edit | core |
set_units | Switches how the project shows lengths and areas (metric or imperial). | Edit | more |
update_project_settings | Changes project-wide settings; only the fields you pass change. | Edit | more |
update_project_meta | Sets the title-block details (client, address, revision, notes), the budget currency and the budget unit rates. | Edit | more |
duplicate_project | Makes an independent copy of the project (every floor and design, new ids throughout) as a new project. | Edit | core |
import_project | Creates a new project from a FloorGen project file, given as json (object or text) or as an https url (JSON or gzip, up to 15 MB). | Edit | more |
export_project_json | Returns the whole project as the text of a.floorgen.json file (traced images embedded; the trash is not included). | Read | more |
delete_project | Deletes a whole project. | Delete (asks to confirm) | more |
restore_project | Brings back a project deleted through this API within the last 30 days, as it was when deleted. | Edit | more |
Floors, designs and scenarios
Storeys, alternative designs of a floor, whole-house scenarios and detached buildings with storey heights of their own.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
list_floors | Lists the floors lowest first. | Read | core |
add_floor | Adds a floor on top, as a basement, or right above a chosen floor, and makes it active. | Edit | core |
update_floor | Changes a floor's name, storey height, type (basement, stilt, ground, upper, terrace) or slab thickness, adds or removes entrance steps up to a ground floor on a plinth, or lines its walls up with the floor below (snap_to_below). | Edit | core |
move_floor | Moves a floor within the stack, to a position (0 is the lowest) or one step up or down. | Edit | more |
delete_floor | Deletes a floor with all its designs. | Delete (asks to confirm) | more |
set_active_floor | Makes a floor (the floor argument) the active one, the floor the app shows and the default for plan tools. | Edit | core |
add_design | Adds an alternative design (variant) to a floor, blank or a copy of an existing one, and makes it the active design, to try a layout without touching the original. | Edit | core |
rename_design | Renames a design. | Edit | more |
set_active_design | Makes the design named by the design argument (id or name) the active design of the floor (the floor argument, default the active floor). | Edit | core |
delete_design | Deletes the design named by the design argument (id or name; by default the active one) from the floor. | Delete (asks to confirm) | more |
list_scenarios | Lists whole-house scenarios. | Read | more |
save_scenario | Saves a scenario. | Edit | more |
apply_scenario | Switches every floor to the design the scenario saved for it, in one change (like calling set_active_design on each floor; floors added later keep their active design). | Edit | more |
delete_scenario | Deletes a scenario. | Edit | more |
set_building | Declares or changes a detached building on the lot (a garage, ADU, barn, shop) that has its own number of storeys and storey heights. | Edit | more |
copy_floor | Copies one floor (the floor argument, default the active floor; its active design, or every design with all_designs) with everything on it. | Edit | more |
rotate_floor | Turns a whole floor 90, 180, 270 or -90 degrees about its centre in one step, e.g. "turn the plan 180 degrees". | Edit | more |
mirror_floor | Flips a whole floor like a mirror image, axis "x" (left and right swap) or "y" (top and bottom swap), e.g. "mirror it" or "flip the layout left to right"; a 180° turn is not a mirror image. | Edit | more |
stretch_plan | Inserts or removes space across the whole plan along a line, or sets its overall size, in one step: e.g. "add 1 ft southward through the hall" ({axis:"y", at:<hall y>, by:"1ft"}) or "make it 14 × 26 m". | Edit | more |
Walls and rooms
Walls are the geometry; rooms are found from closed loops of walls.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
add_walls | Draws walls: a polyline through points (closed:true joins the last point to the first, making a room) or separate segments [{a,b}]. | Edit | core |
update_walls | Paint, finish, thickness, height, gable top of walls (never below a door or window top; windows can rise into a gable). | Edit | core |
set_wall_length | Makes a wall longer or shorter: walls meeting it at right angles slide along so rooms stay square; doors and windows stay put. | Edit | core |
move_wall | Slides a wall square to itself; openings ride along. | Edit | core |
split_wall | Cuts one wall into two joined walls so the joint can be moved (for a slanted or stepped wall). | Edit | more |
set_wall_divider | Turns walls into invisible room dividers (a hairline drawn dashed in 2D and not built in 3D, but still splitting one space into two rooms), or back into normal walls with divider:false. | Edit | more |
add_wall_feature | Builds a niche (a recess into the wall) or a bay window (a bump-out with windows) into a wall. | Edit | more |
update_wall_feature | Resizes a niche or bay window built with add_wall_feature (width about its centre, depth in or out), or flattens it back into a straight wall (remove: true; the bay's side windows go, the front's stay). | Edit | more |
add_columns | Places structural columns (square, round or steel) at points, or on a grid: give the axis positions as grid and a column stands at every crossing, named by axis (Column A1, B1…; letters left to right, numbers top to bottom), with a structural grid line along each axis that has none yet, labelled in bubbles. | Edit | more |
create_room_rect | Draws a rectangular room: four walls from the top-left corner (x, y), width and depth. | Edit | core |
create_room_polygon | Draws a room of any shape from its corners in order (at least 3; sides must not cross). | Edit | core |
create_room_circle | Draws a round room. | Edit | core |
set_wall_curve | Bends an existing wall into an arc, or straightens it (bulge 0). | Edit | more |
add_footprints | Draws up to 100 rooms in one change, each from its corners (points, as create_room_polygon; a flat [x1, y1, x2, y2, …] works too) or a rectangle (x, y, width, depth, as create_room_rect), with its own name and type. | Edit | more |
update_room | Renames a room and sets its type, floor texture and colour, area label, label position, floor level, ceiling, double height, and whether it counts in the area totals. | Edit | core |
split_room | Divides a room in two with a new wall along the line from a to b (ends within 30 cm of a wall of the room snap onto it; ends up to 30 cm past it are cut back to it). | Edit | more |
merge_rooms | Joins two neighbouring rooms into one by removing the wall(s) they share (with any doors and windows in them), like deleting those walls in the editor. | Edit | more |
change_room_use | Changes what a room is used for in one step. | Edit | more |
define_zone | Name an area inside a room, such as Kitchen, Dining and Living in one open-plan room, as a polygon or rectangle in cm that must lie inside the room (1 cm tolerance). | Edit | more |
Doors, windows and finishes
Openings in walls, curtains and blinds, floor and wall finishes.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
add_opening | Adds a door, a window or an open passage to a wall (kind; window_type and grilles for windows; style options). | Edit | core |
update_opening | Changes an existing door, window or passage. | Edit | core |
flip_opening | Flips the side a door swings (or a garage door lifts) to, its hinge end, or both, when a door opens the wrong way; id from add_opening or list_entities. | Edit | more |
add_window_dressing | Hangs curtains or a roller blind on a window (or a sliding or double door). | Edit | more |
list_finishes | Lists the floor finishes and wall materials (id, label, group, whether each suits outdoors, whether it is free on every plan, a floor's usual colour) and some named paint colours. | Read | more |
set_floor_finish | Sets the floor texture and/or colour of rooms and of floor surfaces. | Edit | core |
set_wall_finish | Paints walls and/or sets their material (see list_finishes) on the same faces as the colour. | Edit | more |
list_exterior_faces | Lists the wall faces on a floor that face outside the building (for exterior paint, cladding or windows). | Read | more |
Furniture and fixtures
Search the catalog of about 11,700 models and place, move and restyle items. 1,000 essentials and building parts place on free plans; the full library needs a paid plan.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
list_categories | List the catalogue categories and their subcategories with how many items each holds (free and premium: how many every plan places or not). | Read | core |
search_catalog | Find furniture and fittings by words, category and size. | Read | core |
get_catalog_item | Full details of one catalogue item. | Read | more |
place_item | Place a catalogue item (catalog_id from search_catalog) the way a drop in the editor does. | Edit | core |
update_items | Change placed items (id or ids, by id or name). | Edit | core |
arrange_items | Line up several items, space them evenly, push them against the nearest wall, group them, or restack them. | Edit | more |
place_on_item | Puts an item exactly on top of another (a lamp on a nightstand, a hob on an island, a soffit box over a wall cabinet). | Edit | more |
place_on_wall | Hang an item on one face of a wall, back flush against it and facing into face_room, at offset along the wall from end a and elevation above the floor. | Edit | more |
add_trim_run | Runs a crown moulding or cornice, a skirting board or a picture, dado or plate rail (catalog_id from search_catalog) round a room's inner walls in one call. | Edit | more |
find_free_space | Finds the empty floor in a room or zone, to see where something big fits. | Read | core |
Stairs and lifts
Toolset stairs.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
list_stair_presets | Lists the stair presets add_stair accepts. | Read | stairs |
add_stair | Adds a staircase from a preset on the targeted floor, fitted clear of walls, furniture, lifts and the cores and shafts of other floors. | Edit | stairs |
update_stair | Changes a stair: type, x, y, rotation, flight, build and span_floors / span_to. | Edit | stairs |
set_stair_span | Makes a stair a stair core that repeats on every floor above (each floor gets its own riser count), or turns it back into a single-floor stair. | Edit | stairs |
list_lift_presets | Lists the lift presets add_lift accepts (home, passenger-8, passenger-13, bed, panoramic, goods, car: a parking car lift) with shaft and cabin size in cm, capacity and door. | Read | stairs |
add_lift | Adds a lift (elevator) from a preset on the targeted floor, fitted clear of walls, furniture, stairs, the cores and shafts of other floors and the stairwell openings of stairs from below. | Edit | stairs |
update_lift | Changes a lift: x, y, rotation, name, shaft, cabin and door. | Edit | stairs |
Surfaces, railings, notes and dimensions
Terraces, balconies, cut-outs, railings, notes, dimension lines, the north arrow and section lines.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
add_surface | Draws a wall-less surface on the plan. | Edit | more |
update_surface | Changes a surface's name, kind, finish, colour, thickness, height, slope, opacity, visibility, (cutouts) lid or (balconies) railing. | Edit | more |
edit_surface_points | Moves, inserts or removes corners of a surface. | Edit | more |
clip_surface | Cuts a surface (terrace, floor surface, balcony) with a polygon, rectangle, room or another surface. | Edit | more |
add_balcony | Adds a balcony slab with a glass railing. | Edit | more |
add_railing | Adds a free-standing railing along a polyline (a terrace edge, gallery or landing). | Edit | more |
update_railing | Changes a railing's path, style, height, post spacing, elevation or name. | Edit | more |
measure | Measures the straight-line distance between two points, or the closest distance between two entities (their outlines: a wall's faces, a room's inner wall faces; 0 when they touch or overlap, or a point lies within a wall). | Read | core |
pin_measurement | Pins a dimension line between two points so the length shows on the plan. | Edit | more |
add_note | Writes a text note on the plan (a label, remark or sticky note for the client), or a construction detail callout (detail: a title and its layers, such as a footing, insulation or joists; tagged "detail", so {"tag":"detail"} finds them). | Edit | more |
update_note | Changes a note's text, position, style, size, colour or arrow. | Edit | more |
set_north_arrow | Places the north arrow on the plan and/or sets which way north points. | Edit | more |
set_plot | Draws the site's plot (property line) as points or a width x depth rectangle, with setbacks per edge, per side or one for all, and what lies past each edge (edges: road, neighbour or open; the plan draws a road band or a neighbour hatch past it); changing only setbacks or edges keeps the outline. | Edit | more |
add_section | Adds a section line: a cut through the building from a to b that the app draws as a section view. | Edit | more |
update_annotation | Moves the ends of a pinned dimension line or a section line, sets a dimension's offset, or renames or flips a section. | Edit | more |
Tracing an image or a drawing
Put a scanned plan or photo under the plan and scale it, or import a CAD drawing (DXF) as walls, doors and windows (toolset trace).
| Tool | What it does | Access | Toolset |
|---|---|---|---|
set_background | Puts an image (a scanned plan, sketch or photo) behind the plan to trace over. | Edit | trace |
calibrate_background | Rescales the background image so the distance between two plan points equals a real length. | Edit | trace |
update_background | Changes the background image's opacity, visibility, lock, position or rotation, or removes it. | Edit | trace |
import_dxf | Adds a CAD floor plan (ASCII DXF, R12 to 2018) to the plan on this floor as walls, doors, windows and room names, in one change that undo takes back. | Edit | trace |
Batch edits, copies and the trash
Many edits as one undo step, moving and copying by id, and the restorable trash.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
apply_ops | Run up to 100 edits in order as ONE change and a single undo step. | Edit | core |
list_ops | Lists the op names apply_ops accepts with a one-line summary each (no arguments needed, no project). | Read | core |
transform_entities | Move and/or turn walls, furniture, stairs, lifts, surfaces, notes, measurements and railings by id. | Edit | core |
duplicate_entities | Copies entities by id, e.g. to repeat a bedroom module (its room key) or a furniture group with offset {x: "4m", y: 0}. | Edit | more |
clear_design | Empty the chosen design of a floor: all walls, doors, windows, rooms, furniture, stairs, lifts, surfaces, railings, notes and measurements. | Delete (asks to confirm) | more |
set_layer_flags | Lock, unlock, hide or show entities by id (rooms by key), or whole groups with where (by kind, catalogue category, room, outside every room, tag, or plumbing, gas and duct system; all_floors for the whole building), or everything with scope (design, floor, or project: every floor and design). | Edit | more |
soft_delete | The delete tool, no confirmation needed: removes entities by id into the design's trash, so restore_trash or undo brings them back. | Edit | core |
list_trash | Lists what soft_delete and purge_hidden (toolset more) removed from the chosen design, newest first. | Read | core |
restore_trash | Puts trashed entities back where they were. | Edit | core |
purge_hidden | Moves everything on the chosen design that is hidden (see set_layer_flags) into the trash, so a tracing clutter pass can be cleaned up and still undone with restore_trash. | Edit | more |
empty_trash | Permanently removes entries from the chosen design's trash: pass entries (entry ids from list_trash, or "all") and/or older_than_days. | Delete (asks to confirm) | more |
Structural grid, beams and service runs
Grid lines with their labels, beams under the ceiling, and water, waste, gas and duct runs between service points.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
add_grid_lines | Draws structural grid lines (axes labelled in a bubble at each end, A, B… and 1, 2…) as given, or on axes {x. | Edit | more |
add_beams | Adds structural beams under the ceiling: drawn dashed on the plan (overhead) and as a downstand in 3D. | Edit | more |
update_structure | Moves the ends of a structural grid line or beam, relabels a grid line, resizes a beam, or deletes either with delete. | Edit | more |
add_service_run | Draws a pipe or duct run on the plan. | Edit | more |
update_service_run | Changes a pipe or duct run's kind, corners or size in place, or deletes it with delete: true (undo brings it back). | Edit | more |
Decks and porches
A deck or covered porch with IRC 2021 R507 framing, a guard and stairs.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
add_deck | Builds a deck or porch. | Edit | more |
update_deck | Changes a deck's outline, height, boards, joists, beam, guard, stairs or porch roof, re-sizes the framing from the tables with auto_size, or deletes it with delete. | Edit | more |
Checks and schedules
The same checks as the editor's issue list, the area schedule and geometry clean-up.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
validate_plan | The single audit of the plan; use it after a batch of edits or before showing the plan. | Read | core |
ignore_issues | The Review panel's Ignore. | Edit | core |
check_stairs | Check every stair on the chosen floor (including stair cores coming up from below) for riser and tread comfort, width, headroom, handrail height and ramp slope, under the project's building code. | Read | stairs |
check_clearances | Only the clearance findings of validate_plan, to see if people can move around after placing furniture. | Read | more |
get_schedule | The numbers for a brief or a quote. | Read | more |
audit_furniture | Checks every piece of furniture and reports what is wrong with it. | Read | core |
check_circulation | Checks that a clear path at least 75 cm wide leads from an exterior door (any of them, so each flat of a duplex counts its own; from picks one) to every room's door on the floor, round furniture, stairs and walls. | Read | core |
fix_geometry | Cleans up small slips on the floor and design, in one step. | Edit | more |
repair_plan | Applies the mechanical fixes findings carry (validate_plan rows and audit_furniture findings with a fix). | Edit | core |
check_square | Answers "are the walls square?" the same way every time, without a script. | Read | core |
square_walls | Squares up walls that are slightly off the plan axes in one step (check_square lists them). | Edit | core |
list_labels | Lists every room label (the name, type and finish saved for a room) on the floor and design. | Read | more |
manage_labels | Moves labels between rooms or removes them. | Edit | more |
add_service_point | Marks water supply, drain, waste stack, exhaust, vent or gas points, drawn as small symbols on the plan. | Edit | more |
update_service_point | Moves, relabels or changes the kind of a plumbing, gas or ventilation point in place (e.g. a vent stack that was marked as a plain vent: point_id, kind "stack", label "Soil stack"), keeping its id. | Edit | more |
check_services | Checks the service points on the chosen floor. | Read | more |
Cost, quantities and brief checks
A rough cost range, the materials take-off, Vastu, coverage and floor area ratio, the brief's figures and seat capacity. Estimates and guidance, never quotes or code approval.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
get_takeoff | The quantities for ordering and pricing. | Read | more |
estimate_cost | A ROUGH build-cost range for the plan. | Read | more |
check_vastu | Where the kitchen, bedrooms, prayer room, living and dining rooms, toilets, stairs and the entrance door lie on the compass, set against traditional Vastu Shastra zones. | Read | more |
check_zoning | Site coverage and floor area ratio over the plot (the one drawn with set_plot, else the plot size in settings), compared with limits the user gives. | Read | more |
check_brief | Compares the plan with what a brief asks for. | Read | more |
check_capacity | How many seats and tables a room holds at a standard area per seat for its use, how many seats are placed in it now, and, with seats_needed, whether that many fit (comfortably, tightly or not). | Read | more |
set_assembly | Builds walls, ceilings and floors in layers (cladding, sheathing, framing member and spacing with cavity insulation, continuous insulation, drywall) with R-values. | Edit | more |
set_climate | Sets the climate zone the energy check reads. | Edit | more |
get_energy | The energy design aid. | Read | more |
Electrical, lighting and daylight
Circuits, switch links, light levels, daylight and auto-placed lights. These tools need a plan that includes the electrical and lighting layers.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
get_electrical | Reads the electrical layer, 60 rows a page with total, returned and next_offset (page with offset; read every page before giving a full list). | Read | more |
set_circuits | Creates, changes and deletes the design's electrical circuits and puts devices on them, as one change (e.g. a kitchen counter circuit with two receptacles: circuits [{"name": "Kitchen counter", "tag": "K1", "kind": "receptacle", "amps": 20, "gfci": true}], assign [{"circuit": "K1", "item_ids": ["i_…", "i_…"]}]). | Edit | more |
add_circuit | Adds one circuit to the design's panel, and optionally puts devices on it, as one change (e.g. a GFCI kitchen counter circuit: name "Kitchen counter", tag "K1", kind "receptacle", amps 20, gfci true, item_ids ["i_…"]). | Edit | more |
link_switches | Links switches to the lights they work, adding to what is there (e.g. a 3-way pair at both ends of a hall working its two ceiling lights: switch_ids ["i_sw1", "i_sw2"], load_ids ["i_l1", "i_l2"]). | Edit | more |
unlink_switches | Undoes link_switches. | Edit | more |
move_switch_floor | Moves a wall switch to the floor directly above or below, at the same spot with the same id, keeping its switch link (e.g. a stair's 3-way placed on the wrong floor: {"item_id": "i_…", "to_floor": "Basement"}). | Edit | more |
get_lighting | Reads how much light each room of the floor gets, with its target for the room type and a status (meets, low, dark). | Read | more |
auto_place_lights | Adds ceiling lights to a room in an even grid until its average reaches the lux target for its room type (lumen method), as one change, and wires them. | Edit | more |
Images, elevations, sections and the roof
Pictures the agent can look at, and the elevations and sections the print sets use.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
render_2d | Draws the floor plan as a PNG image (or, with sheet, the site, roof or foundation plan). | Read | core |
render_3d | Draws a 3D view of a floor (or one room) as a PNG image, from a chosen corner, with flat shading and no textures. | Read | more |
render_visual | A paid extra. | Edit (paid) | more |
list_elevations | Lists the elevations: flat, square-on views of the outside of the building. | Read | more |
get_elevation | Reads one elevation as data. | Read | more |
render_elevation | Draws one elevation as a PNG. | Read | more |
add_elevation | Saves an extra elevation looking square at a façade: by bearing, or by a wall's outer side. | Edit | more |
update_elevation | Renames, re-aims or restyles a saved elevation. | Edit | more |
delete_elevation | Deletes a saved elevation (undo brings it back). | Edit | more |
set_roof | Sets the automatic roof over the top floor and over lower floors' rooms with nothing above (not a terrace floor), as 3D and elevations draw it. | Edit | more |
render_section | Draws a cut through the building as a PNG. | Read | more |
3D models
Projects of kind model (FloorGen 3D Modeler): read a model, edit it with batches of ops, build parametric objects and look at it, and export it as GLB, OBJ or STL. Plan tools refuse a model project and these refuse a plan.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
model_read | Describes a 3D model project in words. | Read | core |
model_edit | Changes a 3D model with a batch of ops (1 to 200, at most 20,000 points in all), applied in order as one change. | Edit | core |
model_build | Adds a ready-made parametric object to a 3D model (a pergola, stair, shelf, table and more: model_recipes lists them with their parameters) as a component, placed with its base centre at "at". | Edit | core |
model_rebuild | Remakes a component built with model_build using new parameters; every copy of it in the model follows. | Edit | core |
model_recipes | Lists the parametric objects model_build can make: each recipe kind, what it is, and its parameters with units, bounds and defaults. | Read | core |
model_render | Draws a 3D model as a PNG line drawing with flat shading: an isometric view, the plan from above, or one of four elevations. | Read | core |
model_export | Writes a 3D model project as a file: GLB, OBJ (with its MTL) or STL, the same files the studio's Export dialog makes. | Read | core |
Comparing designs and projects
Side-by-side plans and area tables.
| Tool | What it does | Access | Toolset |
|---|---|---|---|
compare_designs | Compares two designs of one floor. | Read | more |
compare_projects | Compares the areas of 2 to 6 projects side by side. | Read | more |
History, undo and checkpoints
Every agent edit is logged as a transaction that can be inspected and undone (toolset history, except undo).
| Tool | What it does | Access | Toolset |
|---|---|---|---|
get_history | Lists the changes made to a project through agent tools and reverts, newest first. | Read | core |
diff | Shows what a logged change did, entity by entity. | Read | history |
undo | Takes back your own latest change (or the last few with steps); one apply_ops call is one change. | Edit | core |
redo | Brings back what you last undid with undo or undo tx (or the last few with steps). | Edit | core |
restore_entities | Puts the chosen entities back to how they were at an earlier point in the history (a rev, or just before a change), even when other things were edited since. | Edit | history |
create_checkpoint | Saves a named copy of the whole project as it is now, so you can come back to it with restore_checkpoint. | Edit | history |
list_checkpoints | Lists the saved checkpoints of a project, newest first. | Read | history |
restore_checkpoint | Puts the whole project back as it was at a checkpoint. | Delete (asks to confirm) | history |
get_activity | The activity feed of a project, newest first: logged changes (kind "change") and notes people or agents left (kind "note") together. | Read | history |
post_note | Leaves a note in the project's activity feed (shown to the person in the editor), for example to explain a choice or ask a question. | Edit | history |
who_is_here | Shows who has this project open right now. | Read | live |
One-step layouts
Bigger jobs in one call, each a single undo step with a checkpoint before it (toolset macros).
| Tool | What it does | Access | Toolset |
|---|---|---|---|
build_floor | Builds a floor from its room list: walls, doors, windows and stair, no coordinates. | Edit | macros |
generate_layout | Creates a NEW design with a whole floor plan from a room list and switches to it; not for adding a room to the current plan (use create_room_rect). | Edit | macros |
furnish_room | Furnishes a room (all_rooms true: the whole floor, no kind or room) at once (undo removes it) with a ready-made set, clear of doors. | Edit | macros |
connect_rooms | Opens a door (or a plain opening) between two rooms that share a wall: on the longest shared wall, centred where both rooms touch it. | Edit | macros |
add_storey_with_stair | Adds a floor above the target floor and a stair up to it, in one step (direction "down": a basement under the lowest floor and a stair down to it). | Edit | macros |
auto_dimension | Pins dimension lines on the plan: the overall width and depth outside the walls and, if asked, the width and depth of each rectangular room. | Edit | macros |
apply_template | Creates a NEW design from a template's floor plan (ids from list_templates) and switches to it; not for adding a room to the current plan. | Edit | macros |
propose_variant | Offers a change without touching the original. | Edit | macros |
add_adjacent_room | Adds a rectangular room against one side of an existing room in one step. | Edit | macros |
partition_room | Carves a closet, ensuite or pantry out of a corner or a side of a room in one step (an L-shaped or other room square to the compass carves from its own corner furthest that way, or its outermost stretch on that side). | Edit | macros |
resize_room | Moves one side of a room out or in (for an L-shaped or other room square to the compass, its outermost stretch on that side), or sets its net area (area, keep) or its clear inside size (inside_width, inside_depth: measured between the inner wall faces, mixed thicknesses included, landing within 1 mm). | Edit | macros |
add_stair_core | Reserves the same stair rectangle on every floor from from_floor to to_floor and puts a stair in it that climbs through them, in one step. | Edit | macros |
swap_rooms | Swaps what two rooms are. | Edit | macros |
apply_plan_text | Adds and updates rooms, doors, windows and furniture written as plan text, as ONE change and a single undo step. | Edit | macros |
generate_kitchen | Proposes 2 or 3 kitchen layouts for a room or zone and changes nothing; call again with apply true and option n to place one (replacing an earlier generated kitchen; dry_run previews it). | Edit | macros |
generate_bathroom | Proposes 2 or 3 bathroom layouts for a room or zone and changes nothing; call again with apply true and option n to place one (replacing an earlier generated bathroom; dry_run previews it). | Edit | macros |
generate_living | Proposes 2 or 3 living and/or dining layouts for a room or zone and changes nothing; call again with apply true and option n to place one (replacing an earlier generated layout; dry_run previews it). | Edit | macros |
13 prompts and 15 resources
Each prompt is a playbook: a job written out step by step against the real tools, starting with get_context and ending with validate_plan and render_2d.
| Prompt | What it does |
|---|---|
design_home | Design a whole home from a short brief, checked and rendered; report after each step. |
furnish_room | Furnish one room in a design copy with the generator for its type, then check clearances. |
trace_plan | Trace a floor plan image into walls, rooms and openings at scale, one floor at a time, lengths in cm, then check it. |
review_plan | Review a plan and give prioritised feedback; no edits unless the user asks. |
add_storey | Add a floor above with a linked, aligned stair and check the stairs. |
explain_project | Explain the project in plain words for an audience, without editing. |
make_alternative | Try a change in a separate design and compare it with the untouched original. |
audit_and_fix_plan | Find and fix plan problems in small checked steps, or only report (dry_run true or apply false). |
refresh_room | Build new layouts for one room in design copies, never in the original, and compare; nothing switches until the user picks. |
render_review_loop | Render each floor, fix what the pictures show, repeat (at most three rounds). |
safe_destructive_edit | Remove or rebuild part of a plan safely: checkpoint, soft delete, verify; permanent deletes only via confirm and the user's yes. |
compare_designs_report | Compare two designs of one floor and recommend one; read only: no edits, no switching the active design. |
export_plan | Export a plan as pictures of each floor, a 3D view or the whole project file; no edits. |
| URI | What it holds |
|---|---|
floorgen://projects | Your projects: id, name, last change. |
floorgen://catalog | Categories of the furniture catalog with item counts. |
floorgen://stairs/presets | Presets for add_stair and add_lift. |
floorgen://finishes | Floor textures, wall materials and named paints. |
floorgen://schema/project.json | JSON Schema of a.floorgen.json project file. |
floorgen://guide/conventions | Units, axes, ids, references and how edits work. |
floorgen://guide/playbooks | Step-by-step jobs (audit and fix, refresh a room, safe deletes...), the same as the prompts. |
floorgen://projects/{id} | Project facts: floors, designs, settings. |
floorgen://projects/{id}/summary.md | A short readable summary of the project. |
floorgen://projects/{id}/floors/{floor}/designs/{design}/plan.json | One design of one floor as JSON (floor and design by id or name). |
floorgen://projects/{id}/rooms | Rooms of every floor with areas. |
floorgen://projects/{id}/activity | Latest edits and notes, newest first. |
floorgen://projects/{id}/history | Latest transactions with revisions. |
floorgen://catalog/{category} | Items of one catalog category, 100 at a time: add?offset=N for the next page (next_uri gives it). |
floorgen://guide/playbooks/{name} | One playbook: arguments, toolsets and scopes it needs, and the steps. |
Safety rails
- Access levels. Read only, Read & edit, or Full (which can delete), per key or per OAuth grant. A key can be limited to chosen projects and given an expiry.
- Preview and conflicts. Every edit takes
dry_runto see the result without saving, andexpected_revso an edit made on a stale copy is refused. - Two-step deletes. Destructive tools return a confirmation token first; the agent has to ask and call again.
soft_deletemoves things to a trash thatrestore_trashempties back. - Undo and checkpoints. Each call is one logged change that
undoreverses. A checkpoint is saved before macros and deletes, and deleted projects can be restored for 30 days. - Rate limits. 300 calls and 60 edits a minute per key.
More on how these work together: letting AI agents edit floor plans safely.
Questions
Yes, for agents. The editor works without one, but an AI app reaches only projects synced to a FloorGen account, so sign in (free, with Google) and let your projects sync before you connect it.
Any client that speaks MCP over Streamable HTTP: Claude (web, desktop, mobile and Claude Code), ChatGPT in developer mode, Cursor, VS Code with Copilot, Windsurf, Codex CLI, Gemini CLI and Cline, among others.
An OAuth sign-in covers every project in the account. To keep an agent to one job, make an API key limited to chosen projects, and give it Read only or Read & edit access.
Yes. Each tool call is one step in the editor's undo history and one logged transaction that undo reverses, and checkpoints are saved before bigger changes.
render_2d, render_3d and render_elevation return PNG images the agent can look at. File exports (PDF, DXF, IFC, glTF, video) are in the editor's Export menu. The in-app assistant's export_drawing can make a PDF, PNG, SVG, DXF, IFC or CSV while the project is open; over MCP it needs a live editor tab and answers LIVE_TAB_REQUIRED without one.