Use a coding agent

A coding agent helps you write the application that uses Floorkit. Give it your requirements and the public documentation. Your app chooses its UI framework, storage, and AI provider. For an agent that proposes building data inside your app, follow Agent building workflow. Build with agents explains both paths.

Give a coding agent the docs

Use these public resources. No access to the SDK source repository is needed.

Resource	When to use it
Documentation index	Find the guide or API for a task
Quickstart as Markdown	Create a browser app from an empty folder
API overview as Markdown	Find constructors, commands, and related types
Live examples	See the result of a guide and inspect its code
Example index	Find example descriptions and Markdown source pages
Full docs bundle	Supply the complete docs when your tool needs them

Append .md to a documentation page to read its Markdown version. Start with the index and fetch the pages you need. The full bundle is optional.

Connect documentation search through MCP

In an MCP client, add an HTTP server with this address:

https://docs.ploterr.com/mcp

The server searches and retrieves the public Floorkit documentation. Ask it for the guide or API that matches your task.

This is a documentation server. It does not open, edit, save, or export your building. An agent inside your app uses the SDK through the tools that your app provides.

A starting instruction for a coding agent

Give the agent your app requirements and these instructions:

Use the public @opengeometry/floorkit package.
Read https://docs.ploterr.com/llms.txt and the relevant guides before writing code.
Check my installed package version and its index.d.ts against the examples.
Use ProjectManager for a project with editors, views, sheets, and saving.
Initialize the OpenGeometry WebAssembly kernel once before building geometry.
Use supported edit commands; do not change meshes to save a design edit.
Keep model lengths in metres, Y up, and plan points as [x, z].
Preserve authored element IDs. Validate unknown model JSON before building it.
Run the example on localhost. A deployed hostname needs a valid license key.
Use PDF, GLB, or the JSON project file today. IFC and DXF are next-release features.

Your installed index.d.ts gives the available API names and types. The docs explain their meaning. If a guide uses an API that your version lacks, check the changelog before upgrading or choosing a different route.

Run your integration through the quickstart. Before deploying it, read Licensing. For generated models and supported edits, continue with Agent building workflow.

​Give a coding agent the docs

​Connect documentation search through MCP

​A starting instruction for a coding agent

​Next

Give a coding agent the docs

Connect documentation search through MCP

A starting instruction for a coding agent

Next