@autifyhq/aximo-cli 0.16.0 → 0.17.0

package/README.md

@@ -693,7 +693,7 @@ claude mcp add aximo -- aximo mcp
 
 VS Code (Copilot agent mode) uses the same entry under a `servers` key in `.vscode/mcp.json`.
 
-The server exposes 40 tools: 18 read-only ones for inspecting sessions, cases, plans, plan runs, devices, and uploads (`aximo_get_session_timeline` is the load-bearing one for Playwright export; `aximo_wait_for_session` polls a run; `aximo_list_plans` and `aximo_get_plan` cover plan discovery; `aximo_list_plan_runs` and `aximo_get_plan_run` cover run-status polling; `aximo_list_devices`, `aximo_list_user_devices`, and `aximo_list_uploads` supply the device and upload tokens that case configs and run overrides take), 2 that export a session result to a local file (`aximo_export_session_pdf` for the test result report, `aximo_export_session_screenshots` for a ZIP of the step screenshots), 13 that author content (create, update, archive, restore, and delete cases — including a case's per-target device configuration — create, update, archive, restore, and delete plans, add or remove a plan's cases, save a session as a case), 3 that start runs (`aximo_run_case` starts a case run and returns the `sessionId`; `aximo_create_session` starts a session from a prompt with no saved case; `aximo_run_plan` starts a plan run and returns the `planRunId` — all spend organization credits, and the case and plan runs require `apiEnabled`), 1 that stops one (`aximo_cancel_session` cancels a queued or running session), and 3 that manage the local testbox (`aximo_start_testbox`, `aximo_get_testbox`, `aximo_stop_testbox`: a sandboxed Chromium in Docker, registered as a local device, so an agent can test an app on localhost without taking over your screen; see `aximo device testbox`). See the [MCP reference](./skills/aximo-cli/references/mcp.md) for per-client config paths, the full tool table, the Playwright export prompt, and a no-client smoke test.
+The server exposes 41 tools: 19 read-only ones for inspecting sessions, cases, plans, plan runs, devices, uploads, and the credit balance (`aximo_get_credits` reads what is left before a run spends it; `aximo_get_session_timeline` is the load-bearing one for Playwright export; `aximo_wait_for_session` polls a run; `aximo_list_plans` and `aximo_get_plan` cover plan discovery; `aximo_list_plan_runs` and `aximo_get_plan_run` cover run-status polling; `aximo_list_devices`, `aximo_list_user_devices`, and `aximo_list_uploads` supply the device and upload tokens that case configs and run overrides take), 2 that export a session result to a local file (`aximo_export_session_pdf` for the test result report, `aximo_export_session_screenshots` for a ZIP of the step screenshots), 13 that author content (create, update, archive, restore, and delete cases — including a case's per-target device configuration — create, update, archive, restore, and delete plans, add or remove a plan's cases, save a session as a case), 3 that start runs (`aximo_run_case` starts a case run and returns the `sessionId`; `aximo_create_session` starts a session from a prompt with no saved case; `aximo_run_plan` starts a plan run and returns the `planRunId` — all spend organization credits, and the case and plan runs require `apiEnabled`), 1 that stops one (`aximo_cancel_session` cancels a queued or running session), and 3 that manage the local testbox (`aximo_start_testbox`, `aximo_get_testbox`, `aximo_stop_testbox`: a sandboxed Chromium in Docker, registered as a local device, so an agent can test an app on localhost without taking over your screen; see `aximo device testbox`). See the [MCP reference](./skills/aximo-cli/references/mcp.md) for per-client config paths, the full tool table, the Playwright export prompt, and a no-client smoke test.
 
 ## Agent Skills
 

package/dist/commands/mcp/server.test.js

@@ -24,12 +24,13 @@ async function connect() {
     };
 }
 describe("createMcpServer wiring", () => {
-    it("exposes all 40 tools through tools/list with valid JSON Schema", async () => {
+    it("exposes all 41 tools through tools/list with valid JSON Schema", async () => {
         const { client, cleanup } = await connect();
         try {
             const { tools } = await client.listTools();
             expect(tools.map((t) => t.name).sort()).toEqual([
                 "aximo_get_case",
+                "aximo_get_credits",
                 "aximo_get_session",
                 "aximo_wait_for_session",
                 "aximo_cancel_session",
@@ -102,7 +103,7 @@ describe("createMcpServer wiring", () => {
         const { client, cleanup } = await connect();
         try {
             const { tools } = await client.listTools();
-            expect(tools.length).toBe(40);
+            expect(tools.length).toBe(41);
             const result = await client.callTool({ name: "aximo_list_projects", arguments: {} });
             expect(result.isError).toBe(true);
             const content = result.content;

package/dist/commands/mcp/tools.js

@@ -161,6 +161,24 @@ export function defineTools(deps = {}) {
                 return res;
             }),
         },
+        {
+            name: "aximo_get_credits",
+            title: "Get credit balance",
+            description: "Get your organization's credit balance for the current period: granted, used and remaining, in the unit named by creditUnit (legacy or platform). onDemandRemaining is on-demand credit still available once remaining runs out, so remaining can be 0 while runs still start. blocked is true when a new session or run would be refused for lack of credits; metered is false when credits are not enforced. Check it before starting runs to warn when the balance is low.",
+            inputSchema: {},
+            handler: async () => call(async () => {
+                try {
+                    return await request("/api/organizations/credits", {}, deps);
+                }
+                catch (e) {
+                    // Servers before the route answer with Next.js's HTML 404 page.
+                    if (e.status === 404) {
+                        throw Object.assign(new Error("This Aximo server does not support the credit balance yet"), { status: 404 });
+                    }
+                    throw e;
+                }
+            }),
+        },
         {
             name: "aximo_list_devices",
             title: "List Device Farm devices",
@@ -661,7 +679,7 @@ export function defineTools(deps = {}) {
         {
             name: "aximo_run_plan",
             title: "Run test plan",
-            description: "Start a run of a test plan (all its cases) and return the new planRunId, totalCases, and the effective executionMode. The plan must be apiEnabled (aximo_get_plan shows this). All fields except planId are per-run overrides of the plan's stored settings: omit them to run with the saved defaults. Poll aximo_get_plan_run with the returned planRunId to follow the run; wait at least 5 seconds between polls.",
+            description: "Start a run of a test plan (all its cases) and return the new planRunId, totalCases, and the effective executionMode. The plan must be apiEnabled (aximo_get_plan shows this). All fields except planId and mobileConfig are per-run overrides of the plan's stored settings: omit them to run with the saved defaults. mobileConfig is only a fallback (see its description). Poll aximo_get_plan_run with the returned planRunId to follow the run; wait at least 5 seconds between polls.",
             inputSchema: {
                 planId: z.string().uuid(),
                 model: z
@@ -685,7 +703,7 @@ export function defineTools(deps = {}) {
                         .describe("Takes precedence over the single-app uploadArn/uploadType/appName fields."),
                 })
                     .optional()
-                    .describe("Device + app for the plan's mobile cases; overrides the plan's stored config."),
+                    .describe("Fallback device + app, used only for mobile cases with no device saved on the plan or the case. A saved device always wins and keeps its own app; to run on another device, save it on the case or the plan."),
                 desktopConfig: z
                     .object({
                     devices: z.array(z.object({ userDeviceId: z.string().uuid() })).min(1),

package/dist/commands/mcp/tools.test.js

@@ -27,6 +27,7 @@ describe("defineTools", () => {
         const names = defineTools().map((t) => t.name);
         expect(names).toEqual([
             "aximo_list_projects",
+            "aximo_get_credits",
             "aximo_list_devices",
             "aximo_list_user_devices",
             "aximo_list_uploads",
@@ -153,6 +154,37 @@ describe("aximo_list_cases", () => {
         expect(parsed.success).toBe(false);
     });
 });
+describe("aximo_get_credits", () => {
+    it("calls /api/organizations/credits and returns the payload", async () => {
+        const payload = {
+            creditUnit: "platform",
+            granted: 1000,
+            used: 250.5,
+            remaining: 749.5,
+            onDemandRemaining: 0,
+            metered: true,
+            blocked: false,
+        };
+        let captured = null;
+        server.use(http.get(`${TEST_BASE_URL}/api/organizations/credits`, ({ request: req }) => {
+            captured = { method: req.method, url: req.url };
+            return HttpResponse.json(payload);
+        }));
+        const result = await byName(defineTools(), "aximo_get_credits").handler({});
+        expect(result.isError).toBeUndefined();
+        expect(parsePayload(result)).toEqual(payload);
+        expect(captured.method).toBe("GET");
+        expect(new URL(captured.url).pathname).toBe("/api/organizations/credits");
+    });
+    it("says the server is too old instead of returning its HTML 404 page", async () => {
+        server.use(http.get(`${TEST_BASE_URL}/api/organizations/credits`, () => new HttpResponse("<!DOCTYPE html><html>404</html>", { status: 404 })));
+        const result = await byName(defineTools(), "aximo_get_credits").handler({});
+        expect(result.isError).toBe(true);
+        expect(parsePayload(result)).toEqual({
+            error: "This Aximo server does not support the credit balance yet",
+        });
+    });
+});
 describe("aximo_list_projects", () => {
     it("calls /api/organizations/projects and returns the payload", async () => {
         const payload = { projects: [{ id: "p1", name: "Default" }] };

package/dist/commands/schema.js

@@ -109,7 +109,7 @@ export function getSchema() {
                     cmd("run", "POST /api/triggers/plans/{planId}/run", [
                         arg("planId", "positional", "Plan ID", true),
                         arg("model", "string", ""),
-                        arg("mobile-config", "string", "JSON object string"),
+                        arg("mobile-config", "string", "JSON object string: fallback device + app, used only for mobile cases with no device saved on the plan or the case"),
                         ...MUTATE_ARGS,
                     ]),
                     cmd("get", "GET /api/triggers/plans/{planId}/runs/{planRunId}", [

package/dist/commands/trigger/plan/run.d.ts

@@ -20,7 +20,7 @@ declare const _default: import("citty").CommandDef<{
     };
     readonly "mobile-config": {
         readonly type: "string";
-        readonly description: "JSON object string";
+        readonly description: "JSON object string: fallback device + app, used only for mobile cases with no device saved on the plan or the case";
     };
     readonly "execution-mode": {
         readonly type: "string";

package/dist/commands/trigger/plan/run.js

@@ -48,7 +48,10 @@ export default defineCommand({
     args: {
         planId: { type: "positional", required: true },
         model: { type: "string" },
-        "mobile-config": { type: "string", description: "JSON object string" },
+        "mobile-config": {
+            type: "string",
+            description: "JSON object string: fallback device + app, used only for mobile cases with no device saved on the plan or the case",
+        },
         "execution-mode": {
             type: "string",
             description: "parallel or sequential (defaults to the plan's stored setting)",

package/dist/types.d.ts

@@ -231,6 +231,15 @@ export interface Project {
     name?: string | undefined;
     [key: string]: unknown;
 }
+export interface CreditBalance {
+    creditUnit: "legacy" | "platform";
+    granted: number;
+    used: number;
+    remaining: number;
+    onDemandRemaining: number;
+    metered: boolean;
+    blocked: boolean;
+}
 export interface CreateCaseInput {
     projectId: string;
     scenario: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autifyhq/aximo-cli",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Autify Aximo Command Line Interface (CLI)",
   "keywords": [
     "autify",