What problem does it solve?
It solves confusion and runtime failures in VTEX IO backend apps caused by mixing business logic into the Service entrypoint and by leaving execution settings (timeout, memory, replicas, rate limits) unclear or incorrectly configured.
Core Features & Use Cases
- Runtime composition for Node builder services: Define
node/index.ts as the composition root that wires clients and registers runtime surfaces (routes, events, GraphQL handlers).
- Typed Context and State contracts: Establish consistent, type-safe contracts so middleware and handlers can safely share
ctx.state, ctx.vtex, and params without falling back to any.
- Explicit platform execution configuration: Put runtime knobs in
service.json (timeouts, ttl, workers, replicas, rate limiting) and ensure route/event exposure is intentionally declared (including public and smartcache where appropriate).
- Use Case: When your service intermittently times out or scales poorly, restructure the entrypoint and move execution behavior into
service.json, then re-check that routes and event handlers are registered through the runtime layer with matching typed contracts.
Quick Start
Use the vtex-io-service-runtime skill to design your node/index.ts runtime composition and generate an explicit service.json contract for routes, events, and execution sizing for a VTEX IO backend app.