MCP & CLI

Headless entry points for the same execution engine behind Runner:

npm run runner

run

load

npm run mock

npm run mcp

Working directory examples assume the

qasignoff-backend

Collection runner (

npm run runner -- run

)

• Platform Availability: Full Parity (CLI)
• Overview: Execute a Signoff

  *.signoff.json

  or Postman v2.1 collection with environments, dotenv, data files, iterations, workers, retries, and reporters (

  json

  ,

  html

  ,

  pdf

  ,

  junit

  ,

  csv

  ).
• How It Works (Windows App): Export or save collection/env files from the workspace, then run from PowerShell/terminal. UI Runner remains available for interactive plans.
• How It Works (VS Code Extension): Same CLI from the integrated terminal; optional UI Runner while developing.

• Code / Configuration Examples:

-c, --collection <path>

-e, --environment <path>

--env-file <path>

-d, --data <path>

-o, --output <dir>

cwd

--reporters <formats>

json,html,pdf,junit,csv

json

-i, --iteration <n>

1

--delay <ms>

0

--retry <n>

0

-w, --workers <n>

1

1

--timeout <ms>

30000

--bail

false

-v, --verbose

false

--var <pair...>

key=value

--folder <nameOrId>

--request <nameOrId...>

npm run runner -- run \
  -c ./signoff-studio-starter.signoff.json \
  -e ./signoff-studio-starter.httpbingo.signoff.env.json \
  --reporters json,html,junit \
  -o ./reports \
  --bail -v

Exit codes: 0 ok · 1 failures (including assertions) · 2 usage/load/validation.

• Edge Cases, Troubleshooting & Pro-Tips:
  • PDF needs Chrome/Edge or

    SIGNOFF_CHROME_PATH

    (otherwise prefer

    html

    ).

  • --var

    wins over env JSON and dotenv — use for CI secrets injection.
  • Scope with

    --folder

    /

    --request

    for fast PR checks.

Load testing (

npm run runner -- load

)

• Platform Availability: Full Parity (CLI)
• Overview: Process-local VU sessions with ramp, think time, and optional p95 / error-rate gates. See Load testing for UI parity.
• How It Works (Windows App): Use Load panel or CLI; CLI preferred for automation.
• How It Works (VS Code Extension): Same.

• Code / Configuration Examples:

-c, --collection <path>

-e, --environment <path>

--env-file <path>

-o, --output <dir>

cwd

--vus <n>

10

--users <n>

--vus

--duration <ms>

30000

--duration-ms <ms>

--duration

--ramp-up <ms>

0

--ramp-down <ms>

0

--think-time <ms>

0

--p95 <ms>

--error-rate <rate>

--max-vus <n>

50

-v, --verbose

false

--var <pair...>

key=value

--folder <nameOrId>

--request <nameOrId...>

npm run runner -- load -c ./Pets.signoff.json --vus 20 --duration 60000 --p95 500 --error-rate 0.01 -v

Exit codes: 0 thresholds pass · 1 fail · 2 usage.

• Edge Cases, Troubleshooting & Pro-Tips:
  • Not distributed — one process, one machine.
  • Soft-capped by

    --max-vus

    (default 50).

Mock server (

npm run mock

)

• Platform Availability: Full Parity (CLI)
• Overview: Serve a local mock from workspace collection, collection file, or OpenAPI/Swagger. Details in Mocks & OpenAPI.
• How It Works (Windows App): CLI or UI mock actions.
• How It Works (VS Code Extension): CLI from terminal; UI mock from tree.

• Code / Configuration Examples:

-w, --workspace <path>

-c, --collection <id|name|file>

--folder <id|name>

-o, --openapi <path>

-p, --port <n>

0

0

--quiet

false

npm run mock -- --openapi ./petstore.yaml --port 0
npm run mock -- -w C:/abs/workspace -c Pets --folder smoke

• Edge Cases, Troubleshooting & Pro-Tips:
  • Require workspace+collection, collection file, or

    --openapi

    .
  • Absolute workspace paths only;

    ..

    rejected.

MCP server (

npm run mcp

)

• Platform Availability: Full Parity (local stdio MCP)
• Overview: Stdio MCP server (

  signoff-studio

  ) so Cursor or other local MCP clients can list and run collections. Read/execute only — no tool writes collection files. Secrets redacted in tool output.
• How It Works (Windows App): Copy MCP snippet from collection Settings/toolbar when available; run with absolute

  --workspace

  .
• How It Works (VS Code Extension): Same server process; configure in Cursor/

  mcp.json

  independently of the VS Code Signoff webview.

• Code / Configuration Examples:

-w, --workspace <path>

SIGNOFF_WORKSPACE

--workspace

SIGNOFF_COLLECTION

SIGNOFF_MCP_MAX_REQUESTS

run_collection

npm run mcp -- --workspace C:/absolute/path/to/workspace

Cursor / MCP client config:

{
  "mcpServers": {
    "signoff-studio": {
      "command": "node",
      "args": [
        "C:/signoff-studio/signoff-studio-tool/qasignoff-backend/src/mcp/server.mjs",
        "--workspace",
        "C:/absolute/path/to/workspace"
      ]
    }
  }
}

MCP tools

list_collections

list_environments

list_requests

collectionId?

folderId?

query?

get_request

requestId

run_request

requestId

environmentId?

vars?

run_collection

collectionId?

folderId?

environmentId?

bail?

confirmLarge?

{
  "name": "run_request",
  "arguments": {
    "requestId": "GET · Query Params",
    "environmentId": "httpbingo",
    "vars": { "suiteName": "mcp-smoke" }
  }
}

• Edge Cases, Troubleshooting & Pro-Tips:

  • run_collection

    stops after 50 requests unless

    confirmLarge: true

    .
  • Authorization, cookies, and token-like env values are redacted in responses.
  • One workspace per MCP process; restart to switch roots.
  • Point requests at

    npm run mock

    for fully local agent loops.

Workspace normalize (related CLI)

• Platform Availability: Full Parity (CLI utility in backend package)
• Overview:

  workspace:normalize

  (package script) repairs/normalizes on-disk workspace layout for Git-friendly collections. Use when migrating legacy state or after manual file edits.

npm run workspace:normalize -- --workspace C:/absolute/path/to/workspace

• Edge Cases, Troubleshooting & Pro-Tips: Commit after normalize so teammates share the same layout.

Related

• Runner
• Load testing
• Mocks & OpenAPI
• AI assist