Skip to main content
skill CX Codex

vtex-io-service-runtime — Claude Code skill for VTEX IO runtime

Guides the runtime layout of a VTEX IO backend app: the Service entrypoint, typed context, and service.json execution settings.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add vtex/skills --skill vtex-io-service-runtime -a claude-code
Open on GitHub

What vtex-io-service-runtime does

Reach for this skill when the question is how a backend app runs inside the node builder. It treats node/index.ts as the composition root: route, event, and GraphQL handler registration belongs there, business logic does not. Large handler bodies, outbound API calls, or data mapping in that file are a signal to split things out before the service grows further.

Execution knobs sit in service.json rather than in handler code — timeout, memory, workers, minReplicas, maxReplicas, ttl, and rateLimitPerReplica. Routes stay private unless you set public: true on them. smartcache: true is meant for idempotent routes only; put it on an authenticated or write endpoint and repeated requests can get a response that was never theirs. Note that ttl counts minutes and is not a per-request timeout.

Context, State, and param types are shaped so middlewares and handlers share one contract, which keeps ctx.state, ctx.vtex, and params out of any. Authorization fields such as routes.access and routes.policies fall to auth-focused skills, and GraphQL schema or resolver design stays separate — this skill only wires handlers into the runtime.

What it helps with

  • set up node/index.ts as the service composition root
  • define shared Context, State, and param types for handlers
  • move timeout, memory, and replica settings into service.json
  • expose an HTTP route with public: true
  • separate runtime registration from business logic

Example prompts for the agent

  • Scaffold the runtime for a new VTEX IO backend app in node/index.ts
  • Set timeout, memory, and minReplicas in service.json for this service
  • Check whether smartcache: true is safe on this route

How to install vtex-io-service-runtime

1Skills CLI (Vercel)

npx skills add vtex/skills --skill vtex-io-service-runtime -a claude-code

2Manually: put the files in place

~/.claude/skills/vtex-io-service-runtime/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/vtex-io-service-runtime/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about vtex-io-service-runtime

How do I install vtex-io-service-runtime in Claude Code?

Run npx skills add vtex/skills --skill vtex-io-service-runtime -a claude-code. The skill lands in ~/.claude/skills/vtex-io-service-runtime/SKILL.md.

What does vtex-io-service-runtime do?

It covers the runtime of a VTEX IO backend app: the Service entrypoint, typed context and state, service.json parameters, and how routes, events, and GraphQL handlers get registered.

Does it help with GraphQL schema design?

No. It handles runtime-level handler registration only; schema and resolver modeling belong to a separate skill, as do authorization fields in service.json.

Similar skills

All skills for Backend and APIs →

From the same set38

vtex-io-security-boundaries Guides coding assistants when auditing route exposure and data boundaries in VTEX IO apps. Prevents tenant leaks and enforces payload validation. CX Codex +1 1,100installs vtex-io-events-and-workers Guides the agent in writing VTEX IO event handlers and workers that survive duplicate delivery. Useful when slow work should leave your HTTP routes. CX Codex +1 1,100installs vtex-io-service-configuration-apps Guides the agent through building VTEX IO configuration apps using the configuration builder. Helps inject decoupled workspace settings into service runtimes. CX Codex +1 1,100installs vtex-io-app-contract Checks the VTEX IO app contract in manifest.json, including builders and dependency links. Use it when creating, splitting, or publishing apps. CX Codex +1 1,100installs vtex-io-data-access-patterns Guides AI coding agents on picking the right storage layer across VTEX IO apps. It helps design read pipelines, caching strategies, and data boundaries. CX Codex +1 1,100installs vtex-io-auth-tokens-and-context Decides which VTEX IO token should back a backend request: the app itself, a shopper, or an Admin user. CX Codex +1 1,100installs vtex-io-render-runtime-and-blocks Teaches the agent to expose React components as Store Framework blocks in VTEX IO: store/interfaces.json entries, composition and theme wiring. CX Codex +1 1,100installs vtex-io-client-integration Guides backend integrations in VTEX IO apps using @vtex/api and @vtex/clients. Helps select client classes, configure runtime options, and replace raw HTTP calls. CX Codex +1 1,100installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor