Skip to main content
Glama

Create floorplan

create_floorplan

Create a floorplan row. Provide EXACTLY ONE of building_id (per-building floor) or site_id (site-level / campus plan). Typically the web app calls this per page of an uploaded PDF; MCP clients rarely need to call this directly since they do not upload the PDF itself. Requires floorplans:write scope.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "floor_label": "<floor_label>",
      "pdf_storage_path": "<pdf_storage_path>",
      "pdf_filename": "<pdf_filename>"
    },
    "name": "create_floorplan"
  }
}

Input Schema

NameRequiredDescriptionDefault
statusNoDetection status (default: pending)
site_idNoSite this plan belongs to (use for site-level / campus plans; omit if building-scoped) - resolve via list_sites
building_idNoBuilding this floor belongs to (omit if site-scoped) - resolve via list_buildings
floor_labelYesHuman-readable label (e.g. "Ground Floor", "Mezzanine", "Site Plan")
floor_orderNoSort order within the scope (lowest first)
page_numberNo1-indexed page number within the PDF
pdf_filenameYesOriginal filename for display
page_width_ptNoPage width in PDF points (discovered client-side)
page_height_ptNoPage height in PDF points
pdf_storage_pathYesSupabase Storage path to the PDF file

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / building_id / description
      Previous value: -"Building this floor belongs to (omit if site-scoped)"New value: +"Building this floor belongs to (omit if site-scoped) - resolve via list_buildings"
    • changedInput schema / properties / site_id / description
      Previous value: -"Site this plan belongs to (use for site-level / campus plans; omit if building-scoped)"New value: +"Site this plan belongs to (use for site-level / campus plans; omit if building-scoped) - resolve via list_sites"
  2. Changed6 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / building_id / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
    • addedInput schema / properties / floor_order / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / page_number / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / site_id / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
  3. Changed6 schema fields changed
    • changedInput schema / $schema
      Previous value: -"https://json-schema.org/draft/2020-12/schema"New value: +"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / building_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
    • removedInput schema / properties / floor_order / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / page_number / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / site_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
  4. Changed6 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / building_id / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
    • addedInput schema / properties / floor_order / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / page_number / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / site_id / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
  5. First observed

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover the safety profile (readOnly=false, idempotent=false, destructive=false), and the description adds genuinely useful auth context ("Requires floorplans:write scope") plus the XOR validation rule. It does not disclose what a duplicate call produces despite idempotentHint=false, nor what row state is returned, so it adds context but not full behavioral depth.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four short sentences, zero padding, with the identity of the tool front-loaded and the constraint plus the usage caveat following in priority order. Every sentence carries decision-relevant information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 10-parameter mutation with no output schema, it covers the two things an agent most needs: the mutual-exclusion rule and the strong hint that this is normally an app-driven call. It omits what the created row returns and the downstream detection lifecycle implied by the status enum, leaving minor gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3; the description earns an extra point by making the EXACTLY-ONE-OF constraint on building_id/site_id explicit, which the schema only states one-sidedly per field. The remaining eight parameters (status, page geometry, storage path) get no elaboration beyond their schema descriptions, which is acceptable given full coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Create a floorplan row") and immediately narrows scope via the building-vs-site distinction. It does not explicitly differentiate itself from the close sibling create_floorplan_region, so the agent must infer the boundary, but the core purpose is unmistakable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use (one of building_id or site_id per PDF page) and a clear when-NOT-to-use warning: "MCP clients rarely need to call this directly since they do not upload the PDF itself." It stops short of naming a preferred alternative tool for that case, leaving the agent to infer list_floorplans/get_floorplan.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources