Skip to main content

run

Start both the API server and MCP gateway for local development:
synthetiq run
This is the primary local development command. It starts synthetiq server and synthetiq gateway together, providing everything apps and agents need to run locally. There is no separate per-app dev server — all apps in the workspace are served through the runtime.
FlagDefaultDescription
--port <number>5940API server port
--gateway-port <number>5941MCP gateway port

server

Start the API server for workspace agents and multi-app loading:
synthetiq server
The server provides:
  • Multi-app loading — Serves all apps in _apps/ from a single process
  • Agent API — Endpoint for workspace agent interactions
  • Health checks — Monitoring endpoint at /health
FlagDefaultDescription
--port <number>5940Server port

gateway

Start the local MCP gateway for all services in the workspace:
synthetiq gateway
The gateway discovers services from _mcp/, loads them dynamically, and exposes them over the MCP protocol. Apps and agents connect to the gateway to call service tools.
FlagDefaultDescription
--port <number>5941Gateway port
--module-dir <path>Current workspaceWorkspace directory