@nanobpm/urban 0.88.0 → 0.89.0

package/src/runtime/core/modules/api.test.ts

@@ -35,6 +35,9 @@ const engine: EngineClient = {
   searchElementInstanceWaitStates: async () => [],
   getElementInstance: async () => null,
   searchIncidents: async () => [],
+  searchVariables: async () => [],
+  searchJobs: async () => [],
+  getProcessDefinitionXml: async () => null,
   resolveIncident: async () => {},
   updateJobRetries: async () => {},
   setVariables: async () => {},

package/src/runtime/core/modules/cancel.test.ts

@@ -89,6 +89,9 @@ function cancelEngine(opts: {
     searchElementInstanceWaitStates: notUsed("searchElementInstanceWaitStates"),
     getElementInstance: notUsed("getElementInstance"),
     searchIncidents: notUsed("searchIncidents"),
+    searchVariables: notUsed("searchVariables"),
+    searchJobs: notUsed("searchJobs"),
+    getProcessDefinitionXml: notUsed("getProcessDefinitionXml"),
     resolveIncident: notUsed("resolveIncident"),
     updateJobRetries: notUsed("updateJobRetries"),
     setVariables: notUsed("setVariables"),

package/src/runtime/core/modules/connectors.test.ts

@@ -25,6 +25,9 @@ class MiniEngine implements EngineClient {
   async searchElementInstanceWaitStates(): Promise<[]> { return []; }
   async getElementInstance(): Promise<null> { return null; }
   async searchIncidents(): Promise<never[]> { return []; }
+  async searchVariables(): Promise<never[]> { return []; }
+  async searchJobs(): Promise<never[]> { return []; }
+  async getProcessDefinitionXml(): Promise<null> { return null; }
   async resolveIncident(): Promise<void> {}
   async updateJobRetries(): Promise<void> {}
   async setVariables(): Promise<void> {}

package/src/runtime/core/modules/datasource.migrations.test.ts

@@ -24,6 +24,9 @@ const noEngine: EngineClient = {
   searchElementInstanceWaitStates: async () => [],
   getElementInstance: async () => null,
   searchIncidents: async () => [],
+  searchVariables: async () => [],
+  searchJobs: async () => [],
+  getProcessDefinitionXml: async () => null,
   resolveIncident: async () => {},
   updateJobRetries: async () => {},
   setVariables: async () => {},

package/src/runtime/core/modules/instance-tracking.test.ts

@@ -94,6 +94,9 @@ function fakeEngine(
     searchElementInstanceWaitStates: notUsed("searchElementInstanceWaitStates"),
     getElementInstance: notUsed("getElementInstance"),
     searchIncidents: notUsed("searchIncidents"),
+    searchVariables: notUsed("searchVariables"),
+    searchJobs: notUsed("searchJobs"),
+    getProcessDefinitionXml: notUsed("getProcessDefinitionXml"),
     resolveIncident: notUsed("resolveIncident"),
     updateJobRetries: notUsed("updateJobRetries"),
     setVariables: notUsed("setVariables"),

package/src/runtime/core/modules/mcp.test.ts

@@ -91,6 +91,9 @@ function fakeEngine(overrides: Partial<EngineClient> = {}): EngineClient {
     searchElementInstanceWaitStates: async () => [],
     getElementInstance: async () => null,
     searchIncidents: async () => [],
+    searchVariables: async () => [],
+    searchJobs: async () => [],
+    getProcessDefinitionXml: async () => null,
     resolveIncident: async () => {},
     updateJobRetries: async () => {},
     setVariables: async () => {},
@@ -565,6 +568,9 @@ test("the framework debug tools appear and return engine truth", async () => {
   assert.ok(names.includes("urban_debug_search_user_tasks"));
   assert.ok(names.includes("urban_debug_instance_state"));
   assert.ok(names.includes("urban_debug_open_user_tasks"));
+  assert.ok(names.includes("urban_debug_search_variables"));
+  assert.ok(names.includes("urban_debug_search_jobs"));
+  assert.ok(names.includes("urban_debug_get_process_definition_xml"));
 
   const call = await rpc(router, session, "tools/call", {
     name: "urban_debug_search_process_instances",
@@ -574,6 +580,97 @@ test("the framework debug tools appear and return engine truth", async () => {
   assert.deepEqual(JSON.parse(text), [snapshot]);
 });
 
+test("urban_debug_search_variables / search_jobs / get_process_definition_xml are read tools returning engine truth", async () => {
+  const variable = {
+    variableKey: "v-1",
+    name: "prKey",
+    value: '"owner/repo#7"',
+    scopeKey: "pi-1",
+    processInstanceKey: "pi-1",
+    isTruncated: false,
+  };
+  const job = {
+    jobKey: "j-1",
+    type: "senior:pr-review",
+    state: "CREATED",
+    processInstanceKey: "pi-1",
+    retries: 3,
+    elementId: "review",
+  };
+  const seenVarFilters: unknown[] = [];
+  const seenJobFilters: unknown[] = [];
+  const seenXmlKeys: string[] = [];
+  const engine = fakeEngine({
+    searchVariables: async (filter) => {
+      seenVarFilters.push(filter);
+      return [variable];
+    },
+    searchJobs: async (filter) => {
+      seenJobFilters.push(filter);
+      return [job];
+    },
+    getProcessDefinitionXml: async (key) => {
+      seenXmlKeys.push(key);
+      return key === "pd-1" ? "<bpmn:definitions/>" : null;
+    },
+  });
+  const { router } = buildHarness({ engine });
+  const session = await connect(router);
+
+  // All three tools are read tools — they serve on loopback with no credential.
+  const vars = await rpc(router, session, "tools/call", {
+    name: "urban_debug_search_variables",
+    arguments: { processInstanceKey: "pi-1", name: "prKey" },
+  });
+  assert.notEqual(vars.result?.isError, true, "search_variables is a read tool (no credential needed)");
+  assert.deepEqual(JSON.parse(toolContentText(vars.result)), [variable]);
+  assert.deepEqual(seenVarFilters, [{ processInstanceKey: "pi-1", name: "prKey" }]);
+
+  const jobs = await rpc(router, session, "tools/call", {
+    name: "urban_debug_search_jobs",
+    arguments: { processInstanceKey: "pi-1", state: "CREATED" },
+  });
+  assert.notEqual(jobs.result?.isError, true, "search_jobs is a read tool (no credential needed)");
+  assert.deepEqual(JSON.parse(toolContentText(jobs.result)), [job]);
+  assert.deepEqual(seenJobFilters, [{ processInstanceKey: "pi-1", state: "CREATED" }]);
+
+  const xml = await rpc(router, session, "tools/call", {
+    name: "urban_debug_get_process_definition_xml",
+    arguments: { processDefinitionKey: "pd-1" },
+  });
+  assert.notEqual(xml.result?.isError, true, "get_process_definition_xml is a read tool");
+  // The deployed XML is a raw string, surfaced verbatim (not JSON-wrapped).
+  assert.equal(toolContentText(xml.result), "<bpmn:definitions/>");
+  assert.deepEqual(seenXmlKeys, ["pd-1"]);
+
+  // An unknown key returns typed-absent (null) rather than erroring.
+  const absent = await rpc(router, session, "tools/call", {
+    name: "urban_debug_get_process_definition_xml",
+    arguments: { processDefinitionKey: "nope" },
+  });
+  assert.equal(toolContentText(absent.result), "null");
+});
+
+test("the three new debug read tools expose self-contained ($ref-free) input schemas", async () => {
+  const { router } = buildHarness({ engine: fakeEngine() });
+  const session = await connect(router);
+  const list = await rpc(router, session, "tools/list", {});
+  const tools = list.result?.tools;
+  assert.ok(Array.isArray(tools));
+  const names = tools.map((t) => Reflect.get(t, "name"));
+  for (const name of [
+    "urban_debug_search_variables",
+    "urban_debug_search_jobs",
+    "urban_debug_get_process_definition_xml",
+  ]) {
+    assert.ok(names.includes(name), `${name} must appear in tools/list`);
+    const tool: unknown = tools[names.indexOf(name)];
+    const schema: unknown = Reflect.get(tool ?? {}, "inputSchema");
+    assert.equal(Reflect.get(schema ?? {}, "type"), "object", `${name} schema is an object`);
+    assert.ok(!JSON.stringify(schema).includes("$ref"), `${name} schema must be $ref-free`);
+  }
+});
+
 test("an app operationId in the reserved urban_debug_ namespace can't shadow a framework tool", async () => {
   // A `urban_debug_*` operationId is a legal safe path segment, so an app could declare one. Because
   // `CallTool` resolves framework debug tools before app ops, an unreserved namespace would let such

package/src/runtime/core/modules/mcp.ts

@@ -69,10 +69,12 @@ import type {
   HttpRequest,
   HttpResponse,
   IncidentFilter,
+  JobFilter,
   ProcessInstanceState,
   SqliteDb,
   UserTaskFilter,
   UserTaskState,
+  VariableFilter,
   WaitStateType,
 } from "../host.ts";
 import { presentFormIdentifier } from "../host.ts";
@@ -640,6 +642,70 @@ function buildDebugTools(app: AppApi): DebugTool[] {
         return app.engine.searchIncidents(filter);
       },
     },
+    {
+      name: `${DEBUG_PREFIX}search_variables`,
+      description:
+        "Engine truth: search process variables by process instance and/or scope, optionally by name — the read counterpart to set_variables. Reads only, eventually consistent. This is the only way to see a parked token's business payload (prKey, round, an escalation question/answer, resolution, directive); the projections carry lifecycle/position, not the payload. Each result carries the variableKey/name/serialized-JSON value/scopeKey/processInstanceKey/isTruncated.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          processInstanceKey: OPTIONAL_STRING,
+          scopeKey: OPTIONAL_STRING,
+          name: OPTIONAL_STRING,
+        },
+      },
+      run: (args) => {
+        const filter: VariableFilter = {};
+        const pik = readPresentString(args, "processInstanceKey");
+        if (pik) filter.processInstanceKey = pik;
+        const scopeKey = readPresentString(args, "scopeKey");
+        if (scopeKey) filter.scopeKey = scopeKey;
+        const name = readPresentString(args, "name");
+        if (name) filter.name = name;
+        return app.engine.searchVariables(filter);
+      },
+    },
+    {
+      name: `${DEBUG_PREFIX}search_jobs`,
+      description:
+        "Engine truth: search jobs by process instance, state, and/or type/elementId/worker. Reads only, eventually consistent. The 'is it actually stuck?' test: a CREATED job WITH a worker set has been leased by an agent, one with NONE set is merely queued. This is also the on-tool source of a jobKey for retry_job (the only other source is a jobNoRetries incident via search_incidents). Each result carries jobKey/type/state/processInstanceKey and the best-effort worker/retries/elementId/deadline.",
+      inputSchema: {
+        type: "object",
+        properties: {
+          processInstanceKey: OPTIONAL_STRING,
+          state: OPTIONAL_STRING,
+          type: OPTIONAL_STRING,
+          elementId: OPTIONAL_STRING,
+          worker: OPTIONAL_STRING,
+        },
+      },
+      run: (args) => {
+        const filter: JobFilter = {};
+        const pik = readPresentString(args, "processInstanceKey");
+        if (pik) filter.processInstanceKey = pik;
+        const state = readPresentString(args, "state");
+        if (state) filter.state = state;
+        const type = readPresentString(args, "type");
+        if (type) filter.type = type;
+        const elementId = readPresentString(args, "elementId");
+        if (elementId) filter.elementId = elementId;
+        const worker = readPresentString(args, "worker");
+        if (worker) filter.worker = worker;
+        return app.engine.searchJobs(filter);
+      },
+    },
+    {
+      name: `${DEBUG_PREFIX}get_process_definition_xml`,
+      description:
+        "Engine truth: return the deployed BPMN XML of a process definition by key (the routing source of truth, with its FEEL gateway conditions) — reason about WHY an instance routed where it did without a repo checkout. Reads only; null when the key is unknown. An instance carries its processDefinitionKey via search_process_instances, so the path is instance → processDefinitionKey → deployed XML; pair with get_element_instance to locate the parked element.",
+      inputSchema: {
+        type: "object",
+        properties: { processDefinitionKey: OPTIONAL_STRING },
+        required: ["processDefinitionKey"],
+      },
+      run: (args) =>
+        app.engine.getProcessDefinitionXml(requireString(args, "processDefinitionKey")),
+    },
     {
       name: `${DEBUG_PREFIX}cancel_instance`,
       description: "MUTATING: cancel a running process instance. Requires the shared-secret guard.",

package/src/runtime/core/modules/pages.test.ts

@@ -52,6 +52,9 @@ function fakeEngine(): { engine: EngineClient; calls: FakeEngineCalls } {
     async searchElementInstanceWaitStates() { return []; },
     async getElementInstance() { return null; },
     async searchIncidents() { return []; },
+    async searchVariables() { return []; },
+    async searchJobs() { return []; },
+    async getProcessDefinitionXml() { return null; },
     async resolveIncident() {},
     async updateJobRetries() {},
     async setVariables() {},