vtex-io-client-integration — Claude Code skill: setup and usage
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.
npx skills add vtex/skills --skill vtex-io-client-integration -a claude-codeWhat vtex-io-client-integration does
This skill establishes conventions for outbound HTTP calls in VTEX IO backend services. It directs developers toward prebuilt packages in @vtex/api and @vtex/clients for checkout and catalog endpoints. For third-party APIs, it prescribes ExternalClient. It registers everything in node/clients/index.ts through IOClients. Handlers access instances strictly via ctx.clients.
Direct calls with fetch, axios, or got are banned in VTEX IO because raw libraries discard platform authentication and telemetry headers. Transport configuration belongs in InstanceOptions on the client class. The guide suggests timeouts between 1000 and 3000 ms along with small retry limits for idempotent calls.
The scope remains strictly on network transport. It explicitly omits storefront components, GraphQL schemas, route permissions, and manifest.json contracts.
What it helps with
- replace
axiosandfetchcalls with VTEX IO client classes - implement external API integrations using
ExternalClient - register custom clients in
node/clients/index.tsviaIOClients - configure
InstanceOptionswith timeouts, retries, and telemetry metrics - access native commerce clients through
ctx.clientsin backend handlers
Example prompts for the agent
- Create an
ExternalClientsubclass innode/clients/for a third-party payment gateway - Refactor this handler to remove
axiosand usectx.clientsinstead - Configure
InstanceOptionsfor our order client with a 2000 ms timeout and two retries
How to install vtex-io-client-integration
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-client-integration -a claude-code2Manually: put the files in place
~/.claude/skills/vtex-io-client-integration/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/vtex-io-client-integration/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-client-integration -a codex2Manually: put the files in place
.agents/skills/vtex-io-client-integration/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-client-integration -a cursor2Manually: put the files in place
.cursor/skills/vtex-io-client-integration/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install vtex/skills vtex-io-client-integration2Manually: put the files in place
.github/skills/vtex-io-client-integration/SKILL.md1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-client-integration -a gemini-cli2Platform CLI
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-client-integrationManually: put the files in place
.devin/skills/vtex-io-client-integration/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-client-integration -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about vtex-io-client-integration
How do I install vtex-io-client-integration in Claude Code?
Run npx skills add vtex/skills --skill vtex-io-client-integration -a claude-code in your terminal. The tool places the skill definition into ~/.claude/skills/vtex-io-client-integration/SKILL.md.
What is the main purpose of vtex-io-client-integration?
It provides architecture patterns for VTEX IO service integrations, helping you choose between ExternalClient, JanusClient, and @vtex/clients while standardizing error handling and configuration.
Can this skill configure manifest.json or GraphQL schemas?
No, the skill intentionally excludes manifest.json, service.json, GraphQL schemas, and route authorization, focusing purely on client transport logic.
