vtex-io-service-runtime

Define runtime composition for VTEX IO backend services with service.json configuration.

39|9|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/vtex/ai-skills --skill vtex-io-service-runtime
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vtex-io-service-runtime
Source: https://github.com/vtex/ai-skills/tree/main/tracks/vtex-io/skills/vtex-io-service-runtime
Command: npx skills add https://github.com/vtex/ai-skills --skill vtex-io-service-runtime

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Defines a consistent runtime composition for VTEX IO backend services, preventing mixing runtime wiring with business logic and ensuring explicit configuration.

Core Features & Use Cases

  • Explicitly registers routes, events, and GraphQL handlers in the runtime surface.
  • Centralizes runtime knobs (memory, timeout, ttl, replicas) in service.json and enforces typed Context/State contracts.
  • Guides project structure toward a clean separation between node/index.ts as runtime composition root and domain modules.

Quick Start

Implement the service runtime entry point at node/index.ts, configure runtime settings in service.json, and register routes and events to expose the correct runtime surfaces.

Frequently Asked Questions about vtex-io-service-runtime

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define and register routes for a VTEX IO backend service?

To define and register routes for a VTEX IO backend service, implement the runtime entry point at node/index.ts and configure the explicit route exposure in service.json.

What is the correct way to structure a VTEX IO service runtime?

A correct VTEX IO service runtime structure separates node/index.ts as the runtime composition root from domain modules, keeping business logic out of the runtime wiring.

How do I configure runtime knobs like memory and timeout in VTEX IO?

Configure runtime knobs like memory, timeout, ttl, and replicas in VTEX IO by defining them explicitly within the service.json configuration file.

Why should I enforce a typed Context and State for VTEX IO service handlers?

Enforcing a typed Context and State for VTEX IO service handlers ensures a strict runtime contract, preventing the mixing of runtime wiring with business logic.

Can I register GraphQL handlers and events in a VTEX IO service?

Yes, you can register GraphQL handlers and events in a VTEX IO service by explicitly exposing them in the runtime surface defined by your service configuration.

What is the best way to separate business logic from runtime wiring in VTEX IO?

The best way to separate business logic from runtime wiring in VTEX IO is to use node/index.ts strictly as a runtime composition root and place domain logic in separate modules.