# vtex-io-service-runtime

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

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1100 installs · ★ 46
- Author: vtex
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/vtex/skills/tree/HEAD/skills/vtex-io-service-runtime/SKILL.md
- Updated: 2026-10-14
- HTML: https://affpapa.org/en/nevibecode/skills/vtex-io-service-runtime

## What it 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.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-service-runtime -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/vtex-io-service-runtime/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/vtex-io-service-runtime/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-service-runtime -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/vtex-io-service-runtime/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-service-runtime -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/vtex-io-service-runtime/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install vtex/skills vtex-io-service-runtime
```

2. **Manually: put the files in place**
- File: `.github/skills/vtex-io-service-runtime/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-service-runtime -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-service-runtime
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/vtex-io-service-runtime/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-service-runtime -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/vtex/skills/tree/HEAD/skills/vtex-io-service-runtime/SKILL.md

## When to use it
- 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
- 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

## Similar
- [mcp-builder](https://affpapa.org/en/nevibecode/skills/mcp-builder.md) — skill · 130949 installs
- [claude-api](https://affpapa.org/en/nevibecode/skills/claude-api.md) — skill · 74198 installs
- [lark-im](https://affpapa.org/en/nevibecode/skills/lark-im.md) — skill · 472900 installs
- [lark-event](https://affpapa.org/en/nevibecode/skills/lark-event.md) — skill · 466800 installs
- [caveman-discover](https://affpapa.org/en/nevibecode/skills/caveman-discover.md) — skill · 104400 installs
- [migration](https://affpapa.org/en/nevibecode/skills/migration.md) — skill · 103900 installs

From the same set: [vtex/skills](https://affpapa.org/en/nevibecode/by/vtex/skills.md) — 38 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md