vtex-io-graphql-api — Claude Code skill for GraphQL
Guides GraphQL schema and resolver work in VTEX IO apps. Use it when exposing app data through queries or mutations.
npx skills add vtex/skills --skill vtex-io-graphql-api -a claude-codeWhat vtex-io-graphql-api does
The skill covers schema files under graphql/ and resolver code in node/resolvers/. It helps define types, apply @cacheControl and @auth, and connect schema fields to resolvers in the Service entry point. It also calls out the graphql builder in manifest.json; without that declaration, the schema files are ignored.
Public queries need cache rules, while mutations and user-specific data need authentication checks. Resolver keys must correspond to schema field names, and resolvers should access data through ctx.clients. A mismatched key can leave a field returning null without an error in the logs.
What it helps with
- define GraphQL schema fields and types
- connect schema fields to resolver functions
- set cache rules for public queries
- require authentication for mutations and personal data
- trace why a GraphQL schema is not loaded
Example prompts for the agent
- Review the files in
graphql/and add suitable directives to the schema fields. - Connect the fields in
schema.graphqlto theServiceresolvers and check their names. - Check
manifest.jsonand add thegraphqlbuilder if this schema needs it.
How to install vtex-io-graphql-api
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-graphql-api -a claude-code2Manually: put the files in place
~/.claude/skills/vtex-io-graphql-api/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/vtex-io-graphql-api/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-graphql-api -a codex2Manually: put the files in place
.agents/skills/vtex-io-graphql-api/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-graphql-api -a cursor2Manually: put the files in place
.cursor/skills/vtex-io-graphql-api/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install vtex/skills vtex-io-graphql-api2Manually: put the files in place
.github/skills/vtex-io-graphql-api/SKILL.md1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-graphql-api -a gemini-cli2Platform CLI
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-graphql-apiManually: put the files in place
.devin/skills/vtex-io-graphql-api/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-graphql-api -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-graphql-api
How do I install vtex-io-graphql-api in Claude Code?
Run npx skills add vtex/skills --skill vtex-io-graphql-api -a claude-code. The skill file is at ~/.claude/skills/vtex-io-graphql-api/SKILL.md.
What does vtex-io-graphql-api do?
It assists with GraphQL schemas and resolvers for VTEX IO apps, including cache directives and authentication rules.
Why does the app need the graphql builder in manifest.json?
The builder processes schema files in graphql/ and registers the schema with VTEX IO. Without it, the schema is not loaded.