Skip to main content
Glama
Kentucky-ai

opentakeoff-mcp

by Kentucky-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

export_takeoff

Exports takeoff canvas annotations as an app-importable JSON payload, returning data inline or writing it to a chosen file path.

Instructions

The full "opentakeoff.takeoff_canvas.v1" annotations payload — exactly what the app autosaves, importable by it. Returned inline; pass path to also write it to disk as JSON. Coordinates are image px at render scale 2.0: PDF pt × 2, origin top-left, y down (the browser canvas's native space). Sheet payloads carry dims in both px and pt.

Input Schema

NameRequiredDescriptionDefault
pathNoFile path to write the payload to
overwriteNoReplace the file at path even when it is not an OpenTakeoff export. Off by default: re-exporting over a previous export of your own already overwrites without this, so you only need it to deliberately destroy an unrelated file.

Output Schema

NameRequiredDescriptionDefault
rfisNoLive RFI records; withdrawn tombstones are omitted
unitsNoPresent only for a metric project; absent means imperial — the app's own diff-only convention
schemaYes
shapesYes
sheetsYes
markupsYes
approvalsNoApproval-family records (#176) — the estimator's APPROVED seals and the agent's verdict marks {id, actor, ts, sheet_id, at:[nx,ny], shape_id?, text?}. Present only when any exist (the canvas payload's own convention), so a verdict-free export stays byte-identical
proposalsNoProposal batches (#365) — present only when any exist. Shapes reference them by origin.proposal_id; the canvas shows one Accept per batch
conditionsYes
last_groupYes
sheet_tabsYes
client_infoNoWho the proposal is for (client_name, client_address, reference) — present once set_estimate_settings or an import set it
sheet_groupYes
bid_proposalNoThe project's proposal layout and text — present once set
project_nameYes
sheet_levelsNoPresent only when a sheet carries a level label (the app omits it when empty)
estimate_settingsNoThe project's markups (tax_pct, overhead_pct, profit_pct, profit_mode) — present once set
condition_edit_proposalsNoPending condition-edit diffs (#365) — present only when any exist. Nothing on the condition changes until the estimator accepts in the canvas

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.29
    • addedOutput schema / properties / bid_proposal
      Added value: +{
+  "additionalProperties": true,
+  "description": "The project's proposal layout and text — present once set",
+  "properties": {},
+  "type": "object"
+}
    • addedOutput schema / properties / client_info
      Added value: +{
+  "additionalProperties": true,
+  "description": "Who the proposal is for (client_name, client_address, reference) — present once set_estimate_settings or an import set it",
+  "properties": {},
+  "type": "object"
+}
    • addedOutput schema / properties / estimate_settings
      Added value: +{
+  "additionalProperties": true,
+  "description": "The project's markups (tax_pct, overhead_pct, profit_pct, profit_mode) — present once set",
+  "properties": {},
+  "type": "object"
+}
  2. Changed3 schema fields changedv0.1.23
    • addedOutput schema / properties / sheet_levels / description
      Added value: +"Present only when a sheet carries a level label (the app omits it when empty)"
    • addedOutput schema / properties / units / description
      Added value: +"Present only for a metric project; absent means imperial — the app's own diff-only convention"
    • changedOutput schema / required
      Previous value: -[
-  "schema",
-  "project_name",
-  "units",
-  "sheets",
-  "conditions",
-  "shapes",
-  "markups",
-  "sheet_group",
-  "last_group",
-  "sheet_tabs",
-  "sheet_levels"
-]New value: +[
+  "schema",
+  "project_name",
+  "sheets",
+  "conditions",
+  "shapes",
+  "markups",
+  "sheet_group",
+  "last_group",
+  "sheet_tabs"
+]
  3. Changed5 schema fields changedv0.1.21
    • addedOutput schema / properties / condition_edit_proposals
      Added value: +{
+  "description": "Pending condition-edit diffs (#365) — present only when any exist. Nothing on the condition changes until the estimator accepts in the canvas",
+  "items": {
+    "additionalProperties": true,
+    "properties": {
+      "condition_id": {
+        "type": "string"
+      },
+      "id": {
+        "type": "string"
+      },
+      "proposed": {
+        "additionalProperties": true,
+        "properties": {},
+        "type": "object"
+      },
+      "proposed_at": {
+        "type": "string"
+      },
+      "rationale": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "id",
+      "condition_id",
+      "proposed",
+      "rationale",
+      "proposed_at"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}
    • addedOutput schema / properties / proposals
      Added value: +{
+  "description": "Proposal batches (#365) — present only when any exist. Shapes reference them by origin.proposal_id; the canvas shows one Accept per batch",
+  "items": {
+    "additionalProperties": true,
+    "properties": {
+      "created_at": {
+        "type": "string"
+      },
+      "id": {
+        "type": "string"
+      },
+      "label": {
+        "type": "string"
+      },
+      "rationale": {
+        "type": "string"
+      },
+      "withdrawn_at": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "id",
+      "label",
+      "rationale",
+      "created_at"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}
    • addedOutput schema / properties / rfis
      Added value: +{
+  "description": "Live RFI records; withdrawn tombstones are omitted",
+  "items": {},
+  "type": "array"
+}
    • addedOutput schema / properties / sheets / items / properties / scale_confirmed
      Added value: +{
+  "description": "False for agent-set calibration until a human confirms it",
+  "type": "boolean"
+}
    • addedOutput schema / properties / sheets / items / properties / scale_source
      Added value: +{
+  "description": "How the exported calibration was established",
+  "type": "string"
+}
  4. Changed1 schema field changedv0.1.15
    • addedInput schema / properties / overwrite
      Added value: +{
+  "description": "Replace the file at path even when it is not an OpenTakeoff export. Off by default: re-exporting over a previous export of your own already overwrites without this, so you only need it to deliberately destroy an unrelated file.",
+  "type": "boolean"
+}
  5. Changed1 schema field changedv0.1.12
    • addedOutput schema / properties / approvals
      Added value: +{
+  "description": "Approval-family records (#176) — the estimator's APPROVED seals and the agent's verdict marks {id, actor, ts, sheet_id, at:[nx,ny], shape_id?, text?}. Present only when any exist (the canvas payload's own convention), so a verdict-free export stays byte-identical",
+  "items": {},
+  "type": "array"
+}
  6. Changed1 schema field changedv0.1.10
    • changedOutput schema / properties / shapes / items / properties / origin / description
      Previous value: -"Provenance: method (manual|one_click_v1), actor (omitted=human, 'agent'=MCP/automation), reviewed (human affirmed at an explicit gate), and correction fields (edited, edited_before_create, copied, proposed_verts_norm, edits)"New value: +"Provenance: method (manual|one_click_v1), actor (omitted=human, 'agent'=MCP/automation), reviewed (human affirmed at an explicit gate), assignment (where the finish tag came from — {source: 'schedule', room_tag, surface, schedule_sheet} when the room's own schedule row decided it, {source: 'asserted'} when the agent chose; stamped on every agent commit), and correction fields (edited, edited_before_create, copied, proposed_verts_norm, edits)"
  7. Changed4 schema fields changedv0.1.9
    • addedOutput schema / properties / shapes / items / properties / computed / description
      Added value: +"count shapes carry {count} alone; every other role carries area_sf + perimeter_lf"
    • addedOutput schema / properties / shapes / items / properties / computed / properties / count
      Added value: +{
+  "type": "number"
+}
    • removedOutput schema / properties / shapes / items / properties / computed / required
      Removed value: -[
-  "area_sf",
-  "perimeter_lf"
-]
    • changedOutput schema / properties / shapes / items / properties / measure_role / enum
      Previous value: -[
-  "floor_area",
-  "deduct",
-  "linear"
-]New value: +[
+  "floor_area",
+  "deduct",
+  "linear",
+  "surface_area",
+  "count"
+]
  8. Changed1 schema field changedv0.1.3
    • changedOutput schema / properties / shapes / items / properties / origin / description
      Previous value: -"Provenance for one-click traces"New value: +"Provenance: method (manual|one_click_v1), actor (omitted=human, 'agent'=MCP/automation), reviewed (human affirmed at an explicit gate), and correction fields (edited, edited_before_create, copied, proposed_verts_norm, edits)"
  9. Addedv0.1.2
  10. Removedv0.1.1
  11. First observed

TDQS

A3.8/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden and mostly meets it: it discloses the exact payload format identifier, that output is inline by default, and that disk writing is an opt-in side effect. It also spells out the coordinate space (image px at scale 2.0, PDF pt × 2, top-left origin, y down), which is real behavioral context an agent could not otherwise infer. It stops short of saying whether the tool reads only or can disturb app state.

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

Conciseness4/5

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

Three dense sentences, front-loaded with what the payload is before the disk option and the coordinate convention. The coordinate sentence is long but each clause (scale, origin, axis direction) is load-bearing for anyone interpreting the output.

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

Completeness5/5

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

An output schema exists, so return values need no explanation; both parameters are fully documented in the schema; and the description supplies the one thing the schema cannot — the meaning of the coordinate numbers in the payload. Nothing an agent needs in order to call this correctly is missing.

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

Parameters3/5

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

Schema coverage is 100% and the overwrite parameter's schema text is unusually thorough (default-off, destroys unrelated files). The description only restates the path behavior already in the schema ('pass path to also write it to disk as JSON'), so it adds little beyond the structured fields — baseline 3.

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+resource: exports the full 'opentakeoff.takeoff_canvas.v1' annotations payload, inline and optionally to disk. It implicitly separates itself from the other export_* siblings by payload format (canvas annotations vs estimate/proposal/PDF/DXF/report), but never names an alternative export tool, so the differentiation requires inference.

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

Usage Guidelines3/5

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

'importable by it' and 'exactly what the app autosaves' imply a round-trip/backup use case, and 'pass path to also write it to disk' implies the two modes. But there is no explicit when-to-use / when-not, and with six sibling export tools the agent gets no routing rule for choosing this one.

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

Deploy Server

Other Tools