gdharness 0.13.8 → 0.13.10

package/build/cli.js

@@ -15740,7 +15740,7 @@ var init_tool_definitions = __esm(() => {
     {
       name: "editor_launch",
       description: "Opens the Godot editor on a project, in a window on this machine, or restarts the one already connected. An editor goes on serving the addon it read at startup, so restart is what puts a gdharness upgrade into effect; it saves open scenes on the way out and answers with the version that came back. Only an editor with a window can be restarted, because the engine hands back none of the arguments it was started with. editor_status says which editor is connected and whether it is holding an old addon. A restart saves project.godot on the way out, and Godot writes only what differs from its own defaults, so a key named deliberately at its default value is dropped: settingsDropped names any that went, because nothing else will say so until something depends on one.",
-      parameters: { projectPath: PROJECT_PATH },
+      parameters: { projectPath: { ...PROJECT_PATH, ops: ["open"] } },
       requires: [],
       operations: {
         open: { summary: "open the editor on a project", requires: ["projectPath"] },
@@ -15752,7 +15752,7 @@ var init_tool_definitions = __esm(() => {
       name: "editor_run",
       description: "The run: starting the project, stopping it, or booting it once to see whether it comes up clean. start keeps it running and collecting output until it quits or is stopped, windowed where there is a display and headless where there is not, unless headless says otherwise; only runtime_capture needs the window. A run that quits on its own is kept, so a scene that prints an answer and quits is start, then editor_output until running is false. What runs is a scene: a SceneTree script is not an entry point here, so put the script on the root of a scene of its own and name that in scene. args hands the game its own flags, the ones it reads with OS.get_cmdline_user_args(), and a run carrying any is started by this server rather than by the editor. check boots it headless for a few frames, waits for it to quit, and answers with the verdict: whether it came up, and every error and warning it printed on the way. A start waits for the game to become something the runtime_* tools can talk to and says which it is under runtime: listening with the port it took, or why not, so the first call after a start does not have to be made twice. When it is not listening, mayYetAnnounce says whether that is final: false is a runtime that is not coming, true is a game still on its way up, which editor_status will see and runtimeWaitMs waits longer for. A start this server made also answers with transcript, the file both the run's streams are written to, so a watch on it can be armed off the start rather than off a second call.",
       parameters: {
-        projectPath: PROJECT_PATH,
+        projectPath: { ...PROJECT_PATH, ops: ["start", "check"] },
         scene: {
           type: "string",
           ops: ["start", "check"],
@@ -15781,11 +15781,17 @@ var init_tool_definitions = __esm(() => {
           description: "check: how long to give the boot before it is called hung. Default 60000. wait: how long to wait for the run to end before answering anyway. Default 600000."
         }
       },
-      requires: ["projectPath"],
+      requires: [],
       operations: {
-        start: { summary: "run the project until it quits or is stopped", requires: [] },
+        start: {
+          summary: "run the project until it quits or is stopped",
+          requires: ["projectPath"]
+        },
         stop: { summary: "end the run and answer with what it printed last", requires: [] },
-        check: { summary: "boot headless, quit after a few frames, and report the verdict", requires: [] },
+        check: {
+          summary: "boot headless, quit after a few frames, and report the verdict",
+          requires: ["projectPath"]
+        },
         wait: { summary: "wait for the run to end, then answer as editor_output does", requires: [] }
       },
       defaultOperation: "start"
@@ -31168,6 +31174,7 @@ class GodotDAPClient {
   pendingRequests;
   reader = new FrameReader;
   outputBuffer = [];
+  onOutput = null;
   maxOutputLines = 1000;
   initialized = false;
   attached = false;
@@ -31335,6 +31342,13 @@ class GodotDAPClient {
       if (outputText.length > 0) {
         const lines = outputText.split(/\r?\n/).filter((line) => line.length > 0);
         this.outputBuffer.push(...lines);
+        if (this.onOutput !== null) {
+          for (const line of lines) {
+            try {
+              this.onOutput(line);
+            } catch {}
+          }
+        }
       }
       if (this.outputBuffer.length > this.maxOutputLines) {
         this.outputBuffer = this.outputBuffer.slice(this.outputBuffer.length - this.maxOutputLines);
@@ -31391,6 +31405,9 @@ class GodotDAPClient {
     await this.sendRequest("configurationDone", {});
     this.attached = true;
   }
+  setOutputSink(sink) {
+    this.onOutput = sink;
+  }
   getOutput(clear = false) {
     const lines = [...this.outputBuffer];
     if (clear) {
@@ -36435,6 +36452,34 @@ function runningAs(pid) {
     return null;
   }
 }
+function listeningPid(port) {
+  try {
+    if (process.platform === "win32") {
+      const said = execFileSync("powershell", [
+        "-NoProfile",
+        "-NonInteractive",
+        "-Command",
+        `(Get-NetTCPConnection -State Listen -LocalPort ${port} -ErrorAction SilentlyContinue | Select-Object -First 1).OwningProcess`
+      ], { encoding: "utf8", timeout: 15000 }).trim();
+      return /^\d+$/.test(said) ? Number(said) : null;
+    }
+    for (const [command, args, pattern] of [
+      ["lsof", ["-nP", `-iTCP:${port}`, "-sTCP:LISTEN", "-t"], /^(\d+)/],
+      ["ss", ["-ltnpH", `sport = :${port}`], /pid=(\d+)/]
+    ]) {
+      try {
+        const said = execFileSync(command, [...args], { encoding: "utf8", timeout: 15000 }).trim();
+        const found = pattern.exec(said);
+        if (found?.[1] !== undefined) {
+          return Number(found[1]);
+        }
+      } catch {}
+    }
+    return null;
+  } catch {
+    return null;
+  }
+}
 function windowsCommandLine(pid) {
   try {
     const answer = execFileSync("powershell", [
@@ -36567,8 +36612,7 @@ import {
   readdirSync as readdirSync7,
   readFileSync as readFileSync15,
   readSync,
-  rmSync as rmSync9,
-  statSync as statSync4
+  rmSync as rmSync9
 } from "node:fs";
 import { tmpdir as tmpdir5 } from "node:os";
 import { basename as basename3, dirname as dirname9, join as join17, normalize as normalize3 } from "node:path";
@@ -37122,9 +37166,10 @@ class GodotServer {
     if (op !== null) {
       const elsewhere = Object.keys(args).filter((key) => key !== "op" && !opTakes(spec, op, key));
       if (elsewhere.length > 0) {
+        const takes = argumentsOf(spec, op);
         return {
           ok: false,
-          response: this.createErrorResponse(`${spec.name} ${op} does not take ${elsewhere.join(", ")}. ${op} takes: ${argumentsOf(spec, op).join(", ")}.`)
+          response: this.createErrorResponse(`${spec.name} ${op} does not take ${elsewhere.join(", ")}. ${takes.length === 0 ? `${op} takes no arguments.` : `${op} takes: ${takes.join(", ")}.`}`)
         };
       }
     }
@@ -37869,14 +37914,45 @@ class GodotServer {
   async handleDAP(toolName, args) {
     return handleDAPTool(this.dap(), toolName, args);
   }
+  adapterBelongsElsewhere() {
+    const status = this.godotBridge.getStatus();
+    const ours = status.editorPid;
+    if (ours === undefined) {
+      return null;
+    }
+    const port = this.editorServes("dapPort", "GDHARNESS_DAP_PORT", DEFAULT_DAP_PORT);
+    const holder = listeningPid(port);
+    if (holder === null || holder === ours) {
+      return null;
+    }
+    return `The debug adapter on port ${port} belongs to process ${holder}, and the editor on this server's bridge is process ${ours}. Godot gives every editor the same debug adapter port by default, so the one this editor names in its settings is not necessarily the one it holds. Playing the game now would put another editor's console and another project's debugger under this project's name.`;
+  }
   dap() {
     const port = this.editorServes("dapPort", "GDHARNESS_DAP_PORT", DEFAULT_DAP_PORT);
     if (this.dapClient !== null && this.dapClient.port !== port) {
       this.dapClient = null;
     }
-    this.dapClient ??= new GodotDAPClient(port);
+    if (this.dapClient === null) {
+      this.dapClient = new GodotDAPClient(port);
+      this.dapClient.setOutputSink((line) => {
+        this.writeToTranscript(line);
+      });
+    }
     return this.dapClient;
   }
+  writeToTranscript(line) {
+    const run = this.activeProcess;
+    if (run?.throughEditor !== true || run.transcript === null) {
+      return;
+    }
+    try {
+      appendFileSync(run.transcript, line.endsWith(`
+`) ? line : `${line}
+`);
+    } catch (error) {
+      this.logDebug(`Could not write an editor-played run's transcript: ${errorMessage(error)}`);
+    }
+  }
   editorServes(field, variable, fallback) {
     const named = portFromEnvOrNull(variable);
     if (named !== null) {
@@ -38198,6 +38274,14 @@ class GodotServer {
         "GDHARNESS_DAP_PORT points this server at another one"
       ]);
     }
+    const stranger = this.adapterBelongsElsewhere();
+    if (stranger !== null) {
+      return this.createErrorResponse(stranger, [
+        "editor_status names the editor on the bridge and the port it says it serves",
+        "GDHARNESS_DAP_PORT points this server at the right one",
+        "Closing the other editor, or moving its debug adapter port in its editor settings, frees this one"
+      ]);
+    }
     const answer = await this.handleViaBridge("play_scene", scene === null ? {} : { scenePath: `res://${scene}` });
     if (answer.isError === true) {
       return answer;
@@ -38235,20 +38319,11 @@ class GodotServer {
     if (!game.throughEditor || !this.dapClient) {
       return;
     }
-    const heard = [];
-    for (const line of this.dapClient.getOutput(true)) {
-      const ended = line.endsWith(`
+    if (game.transcript === null) {
+      for (const line of this.dapClient.getOutput(true)) {
+        game.log.append("stdout", line.endsWith(`
 `) ? line : `${line}
-`;
-      game.log.append("stdout", ended);
-      heard.push(ended);
-    }
-    if (heard.length > 0 && game.transcript !== null) {
-      try {
-        appendFileSync(game.transcript, heard.join(""));
-        game.readOffset = statSync4(game.transcript).size;
-      } catch (error) {
-        this.logDebug(`Could not write an editor-played run's transcript: ${errorMessage(error)}`);
+`);
       }
     }
     if (!this.dapClient.isConnected()) {

package/build/index.js

@@ -10152,8 +10152,7 @@ import {
   readdirSync as readdirSync6,
   readFileSync as readFileSync11,
   readSync,
-  rmSync as rmSync5,
-  statSync as statSync4
+  rmSync as rmSync5
 } from "node:fs";
 import { tmpdir as tmpdir4 } from "node:os";
 import { basename as basename2, dirname as dirname4, join as join11, normalize as normalize2 } from "node:path";
@@ -25011,6 +25010,7 @@ class GodotDAPClient {
   pendingRequests;
   reader = new FrameReader;
   outputBuffer = [];
+  onOutput = null;
   maxOutputLines = 1000;
   initialized = false;
   attached = false;
@@ -25178,6 +25178,13 @@ class GodotDAPClient {
       if (outputText.length > 0) {
         const lines = outputText.split(/\r?\n/).filter((line) => line.length > 0);
         this.outputBuffer.push(...lines);
+        if (this.onOutput !== null) {
+          for (const line of lines) {
+            try {
+              this.onOutput(line);
+            } catch {}
+          }
+        }
       }
       if (this.outputBuffer.length > this.maxOutputLines) {
         this.outputBuffer = this.outputBuffer.slice(this.outputBuffer.length - this.maxOutputLines);
@@ -25234,6 +25241,9 @@ class GodotDAPClient {
     await this.sendRequest("configurationDone", {});
     this.attached = true;
   }
+  setOutputSink(sink) {
+    this.onOutput = sink;
+  }
   getOutput(clear = false) {
     const lines = [...this.outputBuffer];
     if (clear) {
@@ -28089,6 +28099,34 @@ function runningAs(pid) {
     return null;
   }
 }
+function listeningPid(port) {
+  try {
+    if (process.platform === "win32") {
+      const said = execFileSync("powershell", [
+        "-NoProfile",
+        "-NonInteractive",
+        "-Command",
+        `(Get-NetTCPConnection -State Listen -LocalPort ${port} -ErrorAction SilentlyContinue | Select-Object -First 1).OwningProcess`
+      ], { encoding: "utf8", timeout: 15000 }).trim();
+      return /^\d+$/.test(said) ? Number(said) : null;
+    }
+    for (const [command, args, pattern] of [
+      ["lsof", ["-nP", `-iTCP:${port}`, "-sTCP:LISTEN", "-t"], /^(\d+)/],
+      ["ss", ["-ltnpH", `sport = :${port}`], /pid=(\d+)/]
+    ]) {
+      try {
+        const said = execFileSync(command, [...args], { encoding: "utf8", timeout: 15000 }).trim();
+        const found = pattern.exec(said);
+        if (found?.[1] !== undefined) {
+          return Number(found[1]);
+        }
+      } catch {}
+    }
+    return null;
+  } catch {
+    return null;
+  }
+}
 function windowsCommandLine(pid) {
   try {
     const answer = execFileSync("powershell", [
@@ -28792,7 +28830,7 @@ var TOOL_SPECS = [
   {
     name: "editor_launch",
     description: "Opens the Godot editor on a project, in a window on this machine, or restarts the one already connected. An editor goes on serving the addon it read at startup, so restart is what puts a gdharness upgrade into effect; it saves open scenes on the way out and answers with the version that came back. Only an editor with a window can be restarted, because the engine hands back none of the arguments it was started with. editor_status says which editor is connected and whether it is holding an old addon. A restart saves project.godot on the way out, and Godot writes only what differs from its own defaults, so a key named deliberately at its default value is dropped: settingsDropped names any that went, because nothing else will say so until something depends on one.",
-    parameters: { projectPath: PROJECT_PATH },
+    parameters: { projectPath: { ...PROJECT_PATH, ops: ["open"] } },
     requires: [],
     operations: {
       open: { summary: "open the editor on a project", requires: ["projectPath"] },
@@ -28804,7 +28842,7 @@ var TOOL_SPECS = [
     name: "editor_run",
     description: "The run: starting the project, stopping it, or booting it once to see whether it comes up clean. start keeps it running and collecting output until it quits or is stopped, windowed where there is a display and headless where there is not, unless headless says otherwise; only runtime_capture needs the window. A run that quits on its own is kept, so a scene that prints an answer and quits is start, then editor_output until running is false. What runs is a scene: a SceneTree script is not an entry point here, so put the script on the root of a scene of its own and name that in scene. args hands the game its own flags, the ones it reads with OS.get_cmdline_user_args(), and a run carrying any is started by this server rather than by the editor. check boots it headless for a few frames, waits for it to quit, and answers with the verdict: whether it came up, and every error and warning it printed on the way. A start waits for the game to become something the runtime_* tools can talk to and says which it is under runtime: listening with the port it took, or why not, so the first call after a start does not have to be made twice. When it is not listening, mayYetAnnounce says whether that is final: false is a runtime that is not coming, true is a game still on its way up, which editor_status will see and runtimeWaitMs waits longer for. A start this server made also answers with transcript, the file both the run's streams are written to, so a watch on it can be armed off the start rather than off a second call.",
     parameters: {
-      projectPath: PROJECT_PATH,
+      projectPath: { ...PROJECT_PATH, ops: ["start", "check"] },
       scene: {
         type: "string",
         ops: ["start", "check"],
@@ -28833,11 +28871,17 @@ var TOOL_SPECS = [
         description: "check: how long to give the boot before it is called hung. Default 60000. wait: how long to wait for the run to end before answering anyway. Default 600000."
       }
     },
-    requires: ["projectPath"],
+    requires: [],
     operations: {
-      start: { summary: "run the project until it quits or is stopped", requires: [] },
+      start: {
+        summary: "run the project until it quits or is stopped",
+        requires: ["projectPath"]
+      },
       stop: { summary: "end the run and answer with what it printed last", requires: [] },
-      check: { summary: "boot headless, quit after a few frames, and report the verdict", requires: [] },
+      check: {
+        summary: "boot headless, quit after a few frames, and report the verdict",
+        requires: ["projectPath"]
+      },
       wait: { summary: "wait for the run to end, then answer as editor_output does", requires: [] }
     },
     defaultOperation: "start"
@@ -29876,9 +29920,10 @@ class GodotServer {
     if (op !== null) {
       const elsewhere = Object.keys(args).filter((key) => key !== "op" && !opTakes(spec, op, key));
       if (elsewhere.length > 0) {
+        const takes = argumentsOf(spec, op);
         return {
           ok: false,
-          response: this.createErrorResponse(`${spec.name} ${op} does not take ${elsewhere.join(", ")}. ${op} takes: ${argumentsOf(spec, op).join(", ")}.`)
+          response: this.createErrorResponse(`${spec.name} ${op} does not take ${elsewhere.join(", ")}. ${takes.length === 0 ? `${op} takes no arguments.` : `${op} takes: ${takes.join(", ")}.`}`)
         };
       }
     }
@@ -30623,14 +30668,45 @@ class GodotServer {
   async handleDAP(toolName, args) {
     return handleDAPTool(this.dap(), toolName, args);
   }
+  adapterBelongsElsewhere() {
+    const status = this.godotBridge.getStatus();
+    const ours = status.editorPid;
+    if (ours === undefined) {
+      return null;
+    }
+    const port = this.editorServes("dapPort", "GDHARNESS_DAP_PORT", DEFAULT_DAP_PORT);
+    const holder = listeningPid(port);
+    if (holder === null || holder === ours) {
+      return null;
+    }
+    return `The debug adapter on port ${port} belongs to process ${holder}, and the editor on this server's bridge is process ${ours}. Godot gives every editor the same debug adapter port by default, so the one this editor names in its settings is not necessarily the one it holds. Playing the game now would put another editor's console and another project's debugger under this project's name.`;
+  }
   dap() {
     const port = this.editorServes("dapPort", "GDHARNESS_DAP_PORT", DEFAULT_DAP_PORT);
     if (this.dapClient !== null && this.dapClient.port !== port) {
       this.dapClient = null;
     }
-    this.dapClient ??= new GodotDAPClient(port);
+    if (this.dapClient === null) {
+      this.dapClient = new GodotDAPClient(port);
+      this.dapClient.setOutputSink((line) => {
+        this.writeToTranscript(line);
+      });
+    }
     return this.dapClient;
   }
+  writeToTranscript(line) {
+    const run = this.activeProcess;
+    if (run?.throughEditor !== true || run.transcript === null) {
+      return;
+    }
+    try {
+      appendFileSync(run.transcript, line.endsWith(`
+`) ? line : `${line}
+`);
+    } catch (error) {
+      this.logDebug(`Could not write an editor-played run's transcript: ${errorMessage(error)}`);
+    }
+  }
   editorServes(field, variable, fallback) {
     const named = portFromEnvOrNull(variable);
     if (named !== null) {
@@ -30952,6 +31028,14 @@ class GodotServer {
         "GDHARNESS_DAP_PORT points this server at another one"
       ]);
     }
+    const stranger = this.adapterBelongsElsewhere();
+    if (stranger !== null) {
+      return this.createErrorResponse(stranger, [
+        "editor_status names the editor on the bridge and the port it says it serves",
+        "GDHARNESS_DAP_PORT points this server at the right one",
+        "Closing the other editor, or moving its debug adapter port in its editor settings, frees this one"
+      ]);
+    }
     const answer = await this.handleViaBridge("play_scene", scene === null ? {} : { scenePath: `res://${scene}` });
     if (answer.isError === true) {
       return answer;
@@ -30989,20 +31073,11 @@ class GodotServer {
     if (!game.throughEditor || !this.dapClient) {
       return;
     }
-    const heard = [];
-    for (const line of this.dapClient.getOutput(true)) {
-      const ended = line.endsWith(`
+    if (game.transcript === null) {
+      for (const line of this.dapClient.getOutput(true)) {
+        game.log.append("stdout", line.endsWith(`
 `) ? line : `${line}
-`;
-      game.log.append("stdout", ended);
-      heard.push(ended);
-    }
-    if (heard.length > 0 && game.transcript !== null) {
-      try {
-        appendFileSync(game.transcript, heard.join(""));
-        game.readOffset = statSync4(game.transcript).size;
-      } catch (error) {
-        this.logDebug(`Could not write an editor-played run's transcript: ${errorMessage(error)}`);
+`);
       }
     }
     if (!this.dapClient.isConnected()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdharness",
-  "version": "0.13.8",
+  "version": "0.13.10",
   "mcpName": "io.github.Aureliolo/gdharness",
   "description": "A harness for driving a Godot 4 project from an agent: editor addons, a runtime bridge into the running game, an MCP server in front of them, and a CLI that installs and diagnoses the Godot side.",
   "type": "module",