@jigx/jigx-debug-mcp
v1.0.15
Published
MCP server for publishing Jigx solutions and debugging mobile sessions through Jigx Cloud
Downloads
487
Maintainers
Readme
Jigx Debug MCP
PROD-only MCP server for Codex- and Claude-driven Jigx solution debugging.
Install
Requirements:
- Node.js 22 or newer
- a Jigx user with access to the PROD organization being debugged
- a local Jigx solution folder
One-command setup:
npx -y @jigx/jigx-debug-mcp@latest setupDo not run npm i @jigx/jigx-debug-mcp inside a Jigx app or Core SDK project. This MCP is a local developer tool, not an app runtime dependency. Installing it into an app workspace makes npm resolve that app's existing peer dependencies first, so unrelated React or mobile app dependency conflicts can block the install. Use the setup command above, or install the tool globally with npm install -g @jigx/jigx-debug-mcp.
The setup command installs @jigx/core-sdk, @jigx/sdk-tools@next, and @jigx/jigx-debug-mcp, runs doctor, registers the MCP server for Codex and Claude clients it can find, and installs the Jigx skills for Codex and Claude Code with the Vercel Labs skills CLI:
npx -y skills@latest add jigx-com/skills -s jigx -s jigx-acumatica -a claude-code -a codex -g -yThe skills installer needs Git because it clones jigx-com/skills. On Windows, setup checks for Git and tries to install Git for Windows with winget if it is missing. If PATH does not refresh in the current shell, open a new PowerShell window and rerun npx -y @jigx/jigx-debug-mcp@latest setup --skip-install.
Quick check:
npx -y @jigx/jigx-debug-mcp@latest doctorClean Machine Setup
Use these steps for a new training machine.
macOS
- Install Node.js 22 or newer from nodejs.org if
node --versionis not at leastv22. - Install the app you want to use: Codex Terminal, Codex Desktop, Claude Code, or Claude Desktop.
- Open Terminal and paste:
node --version
npx -y @jigx/jigx-debug-mcp@latest setup- Restart Codex or Claude if it was already open.
- Open your Jigx solution folder in Codex or Claude and ask:
Use the Jigx debug MCP. Log me into Jigx, let me select my organization, and create a debug session for the solution in the current working directory using the mobile app frontline2. The solution is already published.Windows PowerShell
- Install Node.js 22 or newer from nodejs.org if
node --versionis not at leastv22. - Install the app you want to use: Codex Terminal, Codex Desktop, Claude Code, or Claude Desktop.
- Open PowerShell and paste:
node --version
npx -y @jigx/jigx-debug-mcp@latest setup- Restart Codex or Claude if it was already open.
- Open your Jigx solution folder in Codex or Claude and ask:
Use the Jigx debug MCP. Log me into Jigx, let me select my organization, and create a debug session for the solution in the current working directory using the mobile app frontline2. The solution is already published.Solution Name And Mobile App Target
The MCP needs a local solutionPath and an optional mobile app target.
The user normally provides the solution path by opening the solution folder or running the assistant from that folder. The path can also be a generated standalone Core SDK app folder such as /Users/adriaan/Developer/manage-customers/build/app. The MCP walks upward from that path and reads the solution name from the solution files:
- Core SDK solution:
build/output.jsonrootname - generated Core SDK app folder: nearest ancestor
build/output.jsonoroutput.jsonrootname - standard Jigx solution: root
index.jigxrootname
Example standard Jigx solution:
name: field-services-dev-avw
title: Field Services Dev
category: field-servicesThe user does not need to type field-services-dev-avw if the assistant is pointed at the correct folder.
The mobile app target is passed as targetAppName. Use frontline2 for the Frontline 2 branded app, or leave it empty for the standard Jigx app.
create_debug_session returns a deeplink fallback, a scannable PNG QR code image, a saved local PNG file path, and a Markdown image reference in the MCP response. debug_status also returns the QR image again while a session is active.
Codex Terminal
- Install Codex and confirm Node.js 22 or newer is available:
node --version
codex --version- Add the MCP server to Codex:
codex mcp add jigx_debug -- npx -y @jigx/jigx-debug-mcp@latest- Open the Jigx solution folder and start Codex:
cd /absolute/path/to/jigx-solution
codexIn Codex, run
/mcpand confirmjigx_debugis listed.Ask Codex:
Use the Jigx debug MCP. Log me into Jigx, let me select my organization, and create a debug session for the solution in the current working directory using the mobile app frontline2. The solution is already published.Codex Desktop App
- Install the MCP server once from Terminal:
codex mcp add jigx_debug -- npx -y @jigx/jigx-debug-mcp@latest- Open Codex Desktop.
- Open the Jigx solution folder in Codex Desktop.
- In Codex Desktop, run
/mcpand confirmjigx_debugis listed. - Ask Codex:
Use the Jigx debug MCP. Log me into Jigx, let me select my organization, and create a debug session for this workspace folder using the mobile app frontline2. The solution is already published.For longer-running sessions, use ~/.codex/config.toml or a trusted project .codex/config.toml:
[mcp_servers.jigx_debug]
command = "npx"
args = ["-y", "@jigx/jigx-debug-mcp@latest"]
startup_timeout_sec = 30
tool_timeout_sec = 300Claude Code Terminal
- Install Claude Code and confirm Node.js 22 or newer is available:
node --version
claude --version- Add the MCP server to Claude Code:
claude mcp add --transport stdio jigx_debug --scope user -- npx -y @jigx/jigx-debug-mcp@latest- Open the Jigx solution folder and start Claude Code:
cd /absolute/path/to/jigx-solution
claudeIn Claude Code, run
/mcpand confirmjigx_debugis listed.Ask Claude:
Use the Jigx debug MCP. Log me into Jigx, let me select my organization, and create a debug session for the solution in the current working directory using the mobile app frontline2. The solution is already published.Claude Desktop App
Preferred training path: install the Claude Desktop extension bundle provided by Jigx.
- Download or receive
jigx-debug-mcp-<version>.mcpb. - Open Claude Desktop.
- Open Settings > Extensions > Advanced settings > Install Extension.
- Select the
.mcpbfile. - Restart Claude Desktop if prompted.
- Ask Claude:
Use the Jigx debug MCP. Log me into Jigx, let me select my organization, and create a debug session for the solution at /absolute/path/to/jigx-solution using the mobile app frontline2. The solution is already published.Alternative stdio configuration:
{
"mcpServers": {
"jigx_debug": {
"command": "npx",
"args": ["-y", "@jigx/jigx-debug-mcp@latest"]
}
}
}Normal interactive use authenticates with the login_debug_user tool. JIGX_API_KEY_PROD, JIGX_API_KEY, and JIGX_AUTH_TOKEN are optional fallbacks for automation.
See INSTALL.md for expanded local development, plugin, and MCPB installation paths. See RELEASE.md for npm publishing and private file-distributed plugin artifacts.
What It Does
- signs a user into Jigx Cloud with username/password
- lets the user choose an organization
- resolves an already-published solution from a specific path by default
- optionally builds and publishes a Core SDK solution when explicitly requested
- creates a mobile debug session for a chosen mobile app target and returns a deep link plus QR code
- returns the QR code as an actual PNG image content item, saved PNG file path, and Markdown image reference so it can be scanned from desktop clients
- reports current debug lifecycle state and realtime socket health
- captures normalized device events for log analysis
- closes the current mobile debug session cleanly without forcing re-login
- lists SQLite tables on the paired phone
- runs capped SQL queries against the paired phone database
- saves full query results to local JSON files
- executes mutating device SQL when explicitly requested
- clears local phone tables through the Jigx Builder device operation, not generic SQL delete
Intended Flow
login_debug_userselect_debug_organizationcreate_debug_sessionPasstargetAppNamefor branded apps likefrontline2, or leave it empty for the standard Jigx app. Passpublish: trueonly when you explicitly want to build and publish first. Existing sessions are replaced before a new session is created. Passforce: truewhen you want to make the reset explicit after a failed phone handshake.- Scan the QR code image on the phone
debug_statusConfirm the persisted session is present and the realtime socket is healthy if you need a quick health check.track_logs- Reproduce the issue in the app
stop_collecting- Optional:
list_device_tables,query_device_db,save_query_result, orwipe_table close_debug_session- Ask Codex to inspect the captured output
Notes
- PROD only for now
- one active solution/session at a time
- session state and logs are stored in the user's app state directory by default
- set
JIGX_DEBUG_MCP_HOME,JIGX_DEBUG_MCP_STATE_PATH, orJIGX_DEBUG_MCP_LOG_DIRto override local state paths - follow-up tools reconnect the realtime socket on demand when persisted session state exists
create_debug_sessionassumes the solution is already published unlesspublish: truecreate_debug_sessionclears stale runtime/session state before creating a new client token; scan the QR image from the latest create response or calldebug_statusto render it again- the solution name is resolved from
build/output.json,output.json, orindex.jigxat or above the supplied solution path - publish resolves the Jigx SDK workspace root from the supplied
solutionPathand uses the logged-in Jigx user by default; API key env values are optional fallbacks for automation - returned query rows are capped for MCP context hygiene; use
save_query_resultfor full exports wipe_tableuses the mobile table-clear operation; it only uses SQL for before/after row counts
Scripts
npm install
npm run build
npm test
npm run doctor