Vtex Io Graphql API
Apply when working with GraphQL schema files in graphql/ or implementing resolvers in node/resolvers/ for VTEX IO apps. Covers schema.graphql definitions, @cacheControl and @auth directives, custom type definitions, and resolver registration in the Service class. Use for exposing data through GraphQL queries and mutations with proper cache control and authentication enforcement.
Install
/plugin marketplace add vtex/skillsThe repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.
npx skills add vtex/skills --skill vtex-io-graphql-apigit clone --depth 1 https://github.com/vtex/skills.git /tmp/skills
mkdir -p ~/.claude/skills
cp -r /tmp/skills/exports/opencode/vtex-io-graphql-api ~/.claude/skills/vtex-io-graphql-apiPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# GraphQL Schemas & Resolvers ## When this skill applies Use this skill when your VTEX IO app needs to expose a GraphQL API — either for frontend React components to query, for other VTEX IO apps to consume, or for implementing custom data aggregation layers over VTEX Commerce APIs. - Defining schemas in `.graphql` files in the `/graphql` directory - Writing resolver functions in TypeScript in `/node/resolvers/` - Configuring `@cacheControl` and `@auth` directives - Wiring resolvers into the Service class Do not use this skill for: - Backend service structure and client system (use `vtex-io-service-apps` instead) - Manifest and builder configuration (use `vtex-io-app-structure` instead) - MasterData integration details (use `vtex-io-masterdata` instead) ## Decision rules - The `graphql` builder processes `.graphql` files in `/graphql` and merges them into a single schema. - Split definitions across multiple files for maintainability: `schema.graphql` for root types, `directives.graphql` for directive declarations, `types/*.graphql` for custom types. - Use `@cacheControl(scope: PUBLIC, maxAge: SHORT|MEDIUM|LONG)` on all public Query fields. `PUBLIC` = shared CDN cache, `PRIVATE` = per-user cache. - Use `@auth` on all Mutations and on Queries that return sensitive or user-specific data. - Never use `@cacheControl` on Mutations. - Resolver function keys in the Service entry point MUST exactly match the field names in `schema.graphql`.
Details
- Skill name
vtex-io-graphql-api- Repository
- vtex/skills
- Path
exports/opencode/vtex-io-graphql-api/SKILL.md- Repo updated
- 14 October 2026
FAQ
What does the Vtex Io Graphql API skill do?
Apply when working with GraphQL schema files in graphql/ or implementing resolvers in node/resolvers/ for VTEX IO apps. Covers schema.graphql definitions, @cacheControl and @auth directives, custom type definitions, and resolver registration in the Service class. Use for exposing data through GraphQL queries and mutations with proper cache control and authentication enforcement.
How do I install the Vtex Io Graphql API skill?
Claude Code plugin: /plugin marketplace add vtex/skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Vtex Io Graphql API popular?
It lives in vtex/skills, which has 47 GitHub stars and 9 forks.
Related skills
Architecture Well Architected Commerce
47vtex/skills
Apply when scoping, reviewing, or documenting cross-cutting VTEX commerce architecture across storefront, IO, headless, marketplace, payments, or any other VTEX module. Grounds work in the Well-Architected Commerce framework—Technical Foundation (reliability, trust, integrity; security, infrastructure, compliance), Future-proof (innovation, simplicity, efficiency; scalable and adaptable solutions), and Operational Excellence (accuracy, accountability, data-driven improvement; process and customer experience). Routes implementation detail to product tracks (IO caching and paths, Master Data str
Faststore Storefront
47vtex/skills
Core coding rules and workflow for developing VTEX FastStore storefronts. Use when starting any FastStore development task, writing TypeScript/React components, creating section overrides, extending the BFF, or styling. Covers all primary conventions, safety rules, and the development workflow used across every FastStore project.
Headless Bff Architecture
47vtex/skills
Apply when designing or modifying a BFF (Backend-for-Frontend) layer, middleware, or API proxy for a headless VTEX storefront. Covers BFF middleware architecture, public vs private API classification, VtexIdclientAutCookie management, API key protection, and secure request proxying. Use for any headless commerce project that must never expose VTEX_APP_KEY or call private VTEX APIs from the browser.
Vtex Io Rootpath
47vtex/skills
Apply when building VTEX IO apps that must work correctly in multi-binding stores where bindings use path prefixes (e.g. store.com/us/, store.com/br/). Covers rootPath extraction from x-vtex-root-path header, useRuntime().rootPath in React, URL construction in backends, link generation, asset paths, and API route considerations. Use when the app breaks or produces wrong URLs in cross-border or multi-binding setups.
Vtex Io Data Access Patterns
47vtex/skills
Apply when deciding where and how a VTEX IO app should store and read data. Covers when to use app settings, configuration apps, Master Data, VBase, VTEX core APIs, or external stores, and how to avoid duplicating sources of truth or abusing configuration stores for operational data. Use for new data flows, caching decisions, refactors, or reviewing suspicious storage and access patterns in VTEX IO apps.
Vtex Io Service Apps
47vtex/skills
Apply when building backend service apps under node/ in a VTEX IO project or configuring service.json routes. Covers the Service class, middleware functions, ctx.clients pattern, JanusClient, ExternalClient, MasterDataClient, and IOClients registration. Use for implementing backend APIs, event handlers, or integrations that must use @vtex/api clients instead of raw HTTP libraries.
Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.