opentakeoff-mcp 0.1.0 → 0.1.2

package/README.md

@@ -57,6 +57,16 @@ see `src/hush.ts`.)
 `tsx` is a runtime dependency, not a build tool: the engine is imported
 straight from `web/src/lib` as TypeScript, so plain `node` can't run it.
 
+For tool-call debugging, opt into structured stderr tracing:
+
+```bash
+OPENTAKEOFF_MCP_TRACE=1 node --import tsx server.ts
+```
+
+Each tool call writes one JSON line to stderr with the tool name, duration,
+sheet, result size, and error flag. The trace never writes to stdout and never
+includes document text, shape vertices, or result payload content.
+
 ## Tools
 
 | Tool | What it does |

package/dist/server-core.js

@@ -1114,25 +1114,50 @@ var Session = class {
 
 // src/tools.ts
 import { z } from "zod";
+
+// src/trace.ts
+var TRACE_ENV = "OPENTAKEOFF_MCP_TRACE";
+function traceToolCall(tool, args, startedAt, reply) {
+  if (process.env[TRACE_ENV] !== "1") return;
+  const text = reply.content[0]?.text ?? "";
+  const durationMs = Number(process.hrtime.bigint() - startedAt) / 1e6;
+  const sheet = args && typeof args === "object" && "sheet" in args ? args.sheet : void 0;
+  const event = {
+    event: "opentakeoff_mcp_tool_call",
+    tool,
+    duration_ms: Math.round(durationMs * 100) / 100,
+    sheet: typeof sheet === "string" ? sheet : null,
+    result_size: text.length,
+    is_error: reply.isError === true
+  };
+  process.stderr.write(`${JSON.stringify(event)}
+`);
+}
+
+// src/tools.ts
 var COORDS = "Coordinates are image px at render scale 2.0: PDF pt \xD7 2, origin top-left, y down (the browser canvas's native space). Sheet payloads carry dims in both px and pt.";
 var pointSchema = z.tuple([z.number(), z.number()]);
 var roleSchema = z.enum(["floor_area", "deduct"]).default("floor_area");
-var run = (fn) => async (args) => {
+var run = (tool, fn) => async (args) => {
+  const startedAt = process.hrtime.bigint();
+  let reply;
   try {
-    return ok(await fn(args));
+    reply = ok(await fn(args));
   } catch (e) {
-    return fail(e);
+    reply = fail(e);
   }
+  traceToolCall(tool, args, startedAt, reply);
+  return reply;
 };
 function registerTools(server, session) {
   server.registerTool("load_plan", {
     description: `Open a plan PDF from disk and replace the whole session (previous document, scales, conditions, and shapes are cleared). Returns file, page_count, and one entry per sheet: dims, title-block sheet_number, and the detected drawn scale where present. ${COORDS}`,
     inputSchema: { path: z.string().describe("Path to a plan PDF on disk") }
-  }, run(({ path: path3 }) => session.loadPlan(path3)));
+  }, run("load_plan", ({ path: path3 }) => session.loadPlan(path3)));
   server.registerTool("sheet_info", {
     description: `Sheet detail: dims (px and pt), vector segment count, whether the sheet has vector linework (one_click needs it), scale status, the detected scale suggestion, and this sheet's committed shape count. ${COORDS}`,
     inputSchema: { sheet: z.string().describe('Sheet key ("plan.pdf", "plan.pdf#2") or title-block number ("A-101")') }
-  }, run(({ sheet }) => session.sheetInfo(sheet)));
+  }, run("sheet_info", ({ sheet }) => session.sheetInfo(sheet)));
   server.registerTool("set_scale", {
     description: `Set a sheet's scale \u2014 exactly ONE of: label (a standard scale, e.g. '1/4" = 1'-0"'), upp (real feet per image px), calibrate (two points along a known dimension plus its real feet), or use_detected (adopt the drawn scale note read off the sheet). The detected scale is never applied automatically \u2014 setting it is always this explicit call. ${COORDS}`,
     inputSchema: {
@@ -1142,7 +1167,7 @@ function registerTools(server, session) {
       calibrate: z.object({ p1: pointSchema, p2: pointSchema, feet: z.number() }).optional().describe("Two points (image px) a known real distance apart, and that distance in feet"),
       use_detected: z.boolean().optional().describe("true = adopt the sheet's detected scale")
     }
-  }, run((a) => {
+  }, run("set_scale", (a) => {
     const given = [a.label !== void 0, a.upp !== void 0, a.calibrate !== void 0, a.use_detected !== void 0].filter(Boolean).length;
     if (given !== 1) throw new UserError("Provide exactly one of: label, upp, calibrate, use_detected.");
     return session.setScale(a.sheet, a);
@@ -1157,7 +1182,7 @@ function registerTools(server, session) {
       role: roleSchema,
       return_verts: z.boolean().default(false).describe("Include the traced polygon's vertices (image px)")
     }
-  }, run((a) => session.oneClick(a.sheet, a.x, a.y, { condition: a.condition, role: a.role, returnVerts: a.return_verts })));
+  }, run("one_click", (a) => session.oneClick(a.sheet, a.x, a.y, { condition: a.condition, role: a.role, returnVerts: a.return_verts })));
   server.registerTool("measure_polygon", {
     description: `Measure a closed polygon you supply (min 3 vertices, image px): area_sf and perimeter_lf at the sheet's scale. Requires the scale to be set. Pass condition to commit it; role "deduct" subtracts. ${COORDS}`,
     inputSchema: {
@@ -1166,7 +1191,7 @@ function registerTools(server, session) {
       condition: z.string().optional(),
       role: roleSchema
     }
-  }, run((a) => session.measurePolygon(a.sheet, a.verts, { condition: a.condition, role: a.role })));
+  }, run("measure_polygon", (a) => session.measurePolygon(a.sheet, a.verts, { condition: a.condition, role: a.role })));
   server.registerTool("measure_line", {
     description: `Measure an open polyline (min 2 points, image px): length_lf at the sheet's scale. Requires the scale to be set. Pass condition to commit it as a linear shape (base, transitions, feature strips). ${COORDS}`,
     inputSchema: {
@@ -1174,15 +1199,15 @@ function registerTools(server, session) {
       pts: z.array(pointSchema).min(2),
       condition: z.string().optional()
     }
-  }, run((a) => session.measureLine(a.sheet, a.pts, { condition: a.condition })));
+  }, run("measure_line", (a) => session.measureLine(a.sheet, a.pts, { condition: a.condition })));
   server.registerTool("takeoff_summary", {
     description: `Per-condition totals (floor/wall/border SF, LF, EA, SY, with and without waste) plus grand totals \u2014 the Report's numbers, computed by the same rules. ${COORDS}`,
     inputSchema: {}
-  }, run(() => session.summary()));
+  }, run("takeoff_summary", () => session.summary()));
   server.registerTool("export_takeoff", {
     description: `The full "opentakeoff.takeoff_canvas.v1" annotations payload \u2014 exactly what the app autosaves, importable by it. Returned inline; pass path to also write it to disk as JSON. ${COORDS}`,
     inputSchema: { path: z.string().optional().describe("File path to write the payload to") }
-  }, run(async ({ path: outPath }) => {
+  }, run("export_takeoff", async ({ path: outPath }) => {
     const payload = session.exportPayload();
     if (outPath) {
       const { writeFile } = await import("node:fs/promises");
@@ -1193,19 +1218,75 @@ function registerTools(server, session) {
   server.registerTool("delete_shape", {
     description: `Remove a committed shape by the id returned when it was committed. ${COORDS}`,
     inputSchema: { shape_id: z.string() }
-  }, run(({ shape_id }) => session.deleteShape(shape_id)));
+  }, run("delete_shape", ({ shape_id }) => session.deleteShape(shape_id)));
   server.registerTool("read_sheet_text", {
     description: `The sheet's text with positions \u2014 items [{str, x, y}] in image px plus the joined text. Optionally restrict to a region {x0, y0, x1, y1}. Use it to read title blocks, room labels, finish schedules, and scale notes. ${COORDS}`,
     inputSchema: {
       sheet: z.string(),
       region: z.object({ x0: z.number(), y0: z.number(), x1: z.number(), y1: z.number() }).optional()
     }
-  }, run((a) => session.readSheetText(a.sheet, a.region)));
+  }, run("read_sheet_text", (a) => session.readSheetText(a.sheet, a.region)));
 }
 
+// package.json
+var package_default = {
+  name: "opentakeoff-mcp",
+  version: "0.1.2",
+  mcpName: "io.github.kentucky-ai/opentakeoff",
+  type: "module",
+  description: "OpenTakeoff MCP server \u2014 drive the takeoff engine from your MCP client over stdio.",
+  license: "Apache-2.0",
+  engines: {
+    node: ">=20"
+  },
+  scripts: {
+    dev: "node --import tsx server.ts",
+    start: "node dist/server.js",
+    build: "esbuild server.ts --bundle --platform=node --format=esm --packages=external --outfile=dist/server-core.js && node scripts/finish-build.mjs",
+    prepublishOnly: "npm run typecheck && npm test && npm run build",
+    typecheck: "tsc --noEmit",
+    test: "node --import tsx --test test/*.test.ts"
+  },
+  dependencies: {
+    "@modelcontextprotocol/sdk": "^1.12.0",
+    "pdfjs-dist": "^4.10.38",
+    zod: "^3.24.1"
+  },
+  devDependencies: {
+    "@types/node": "^22.19.21",
+    typescript: "^5.7.2",
+    tsx: "^4.19.2",
+    esbuild: "^0.24.2"
+  },
+  bin: {
+    "opentakeoff-mcp": "dist/server.js"
+  },
+  main: "dist/server.js",
+  files: [
+    "dist",
+    "README.md"
+  ],
+  repository: {
+    type: "git",
+    url: "git+https://github.com/Kentucky-ai/opentakeoff.git",
+    directory: "mcp"
+  },
+  homepage: "https://github.com/Kentucky-ai/opentakeoff/tree/main/mcp",
+  keywords: [
+    "mcp",
+    "model-context-protocol",
+    "takeoff",
+    "construction",
+    "estimating",
+    "pdf",
+    "quantity-takeoff",
+    "flooring"
+  ]
+};
+
 // server.ts
 function buildServer(session = new Session()) {
-  const server = new McpServer({ name: "opentakeoff", version: "0.1.0" });
+  const server = new McpServer({ name: "opentakeoff", version: package_default.version });
   registerTools(server, session);
   return server;
 }

package/dist/server.js

@@ -5,7 +5,6 @@
 // module that defers the server (and its hoisted externals) behind a dynamic
 // import. Same belt as src/hush.ts, one module earlier.
 console.log = console.error.bind(console);
-
 // pdf.js 4.x needs Promise.withResolvers (Node 22+); polyfill here so the
 // engines floor stays Node 20 — must exist before pdfjs-dist evaluates.
 if (typeof Promise.withResolvers !== "function") {

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "opentakeoff-mcp",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "mcpName": "io.github.kentucky-ai/opentakeoff",
   "type": "module",
   "description": "OpenTakeoff MCP server \u2014 drive the takeoff engine from your MCP client over stdio.",
   "license": "Apache-2.0",
@@ -10,7 +11,7 @@
   "scripts": {
     "dev": "node --import tsx server.ts",
     "start": "node dist/server.js",
-    "build": "esbuild server.ts --bundle --platform=node --format=esm --packages=external --outfile=dist/server-core.js && cp bin.js dist/server.js && chmod +x dist/server.js",
+    "build": "esbuild server.ts --bundle --platform=node --format=esm --packages=external --outfile=dist/server-core.js && node scripts/finish-build.mjs",
     "prepublishOnly": "npm run typecheck && npm test && npm run build",
     "typecheck": "tsc --noEmit",
     "test": "node --import tsx --test test/*.test.ts"
@@ -50,4 +51,4 @@
     "quantity-takeoff",
     "flooring"
   ]
-}
+}