Argent
Argent has two HTTP surfaces:
- Tools server — Node/Express app (port 3001) that lists and invokes tools via a registry. Manages simulator lifecycle, debugger connections, and all tool logic.
- Simulator server — Native arm64 macOS binary (repo root) that runs one process per simulator. Handles device I/O: touch, keys, buttons, rotation, paste, scroll, MJPEG stream, screenshots, recording.
The tools server spawns simulator-server processes on demand. The UI and MCP bridge both talk to the tools server; the tools server talks to simulator-server instances.
Packages
| Package | Path | Purpose |
|---|---|---|
@argent/registry |
packages/registry |
Core library: dependency-aware service lifecycle, blueprints, tools, URNs. No HTTP or simulator logic. |
@argent/tool-server |
packages/tool-server |
HTTP API over the registry (GET /tools, POST /tools/:name). Registers all blueprints and tools. |
@argent/mcp |
packages/mcp |
MCP bridge — exposes all tools to AI assistants (Claude, Cursor) via Model Context Protocol. |
@argent/skills |
packages/skills |
Markdown skill files that instruct AI agents when/how to use Argent tools. |
Requirements
- macOS with Xcode installed (for
xcrun simctl) - Node.js 18+
- The
simulator-serverbinary at the repo root (arm64 macOS)
Getting started
npm install
Run the tools server
npm run start
This builds the registry, then starts the tools server on port 3001.
npm run start:tool-server # equivalent alias
Test it:
curl http://localhost:3001/tools # list tools
curl -X POST http://localhost:3001/tools/list-simulators \
-H "Content-Type: application/json" -d '{}' # invoke a tool
Installing in a project
The argent package is distributed via GitHub Packages under the @software-mansion scope. Because the source repository is private, you must authenticate before installing.
See INSTALL.md for the full step-by-step guide (token setup, .npmrc configuration, and the install command).
Quick start (after completing auth setup):
npx @software-mansion/argent install
This installs the package from GitHub Packages and configures MCP servers in .claude/mcp.json, .cursor/mcp.json, and copies skills, agents, and rules into your workspace.
VS Code launch configs
| Config | What it does |
|---|---|
| Install Argent in Project | Prompts for a folder path, then builds, installs, and configures argent in that project. |
| Argent Agent Debug | Same as above but also opens the project in a new VS Code window and launches the tools server with debugger attached. |
| Tools Server | Runs the tool-server with ts-node on port 3001. |
| Tools Server (built) | Builds first, then runs the compiled tool-server. |
| UI (Chrome) | Opens the Vite UI in Chrome. |
| Full (Tools + UI) | Compound — starts both Tools Server and UI. |
Building and testing
npm run build # tsc --build (all packages)
npm test -w @argent/registry # registry unit tests (vitest)
npm test -w @argent/tool-server # tool-server tests (vitest)
MCP package
npm run build -w @software-mansion/argent # compile + bundle into single CJS file
npm run pack:mcp # build and create argent-<version>.tgz
Simulator server API
The simulator-server binary is normally spawned by the tools server. To run it standalone:
./simulator-server ios --id <UDID> # defaults: port 3000, replay on, touch overlay on
./simulator-server ios --id <UDID> --port 8080 --no-replay # custom port, replay off
| Flag | Env var | Default | Description |
|---|---|---|---|
--port N |
PORT |
3000 |
Listen port |
--replay / --no-replay |
REPLAY |
true |
Rolling replay buffer |
--show-touches / --no-show-touches |
SHOW_TOUCHES |
true |
Touch pointer overlay |
License (Pro features)
Screenshot, recording, and replay require a Pro/Team/Enterprise JWT. Free-tier endpoints (touch, keys, buttons, rotate, paste, scroll, MJPEG stream) work without one.
curl http://localhost:3000/fingerprint # 1. get machine fingerprint
curl -X POST http://localhost:3000/token/activate \
-H "Content-Type: application/json" \
-d '{"licenseKey": "<your-key>"}' # 2. activate license
# 3. pass returned token when creating a session, or PUT /sessions/:id/token
Quick reference (curl)
curl http://localhost:3000/simulators/running # list running simulators
curl -X POST http://localhost:3000/sessions \
-H "Content-Type: application/json" \
-d '{"udid": "<UDID>", "token": "<JWT>"}' # create session
curl -X POST http://localhost:3000/sessions/<id>/screenshot # screenshot (Pro)
curl -X POST http://localhost:3000/sessions/<id>/input/touch \
-H "Content-Type: application/json" \
-d '{"type":"Down","points":[{"x":0.5,"y":0.5}]}' # tap (normalized 0-1)
Further reading
See docs/reference.md for a detailed breakdown of the registry, blueprints, services, tools, and how they all connect.