VTEX Developer MCP

Connect your AI coding assistant to VTEX documentation and API references using the Model Context Protocol (MCP).

VTEX Developer MCP is a Model Context Protocol (MCP) server, available as part of the VTEX AI Developer Toolkit. It connects AI coding assistants to VTEX documentation (Help Center and Developer Portal) and the API Reference, allowing assistants to retrieve documentation content and API specifications directly from VTEX sources during a task.

The VTEX AI Developer Toolkit also includes VTEX Skills. VTEX Skills and VTEX Developer MCP are complementary: VTEX Developer MCP retrieves documentation and API references at runtime, while VTEX Skills loads persistent platform context before a task starts.

Available tools

The VTEX Developer MCP exposes four tools:

Tool	Description	Parameters
`search_documentation`	Hybrid semantic and keyword search across VTEX Help Center and Developer Portal content	`query` (required), `locale` (required: `en`, `es`, `pt`), `limit` (default 10, max 50), `format`
`fetch_document`	Retrieves the full content of a VTEX documentation article by URL	`url` (required), `format`
`search_endpoints`	Hybrid semantic and keyword search over VTEX API endpoints in OpenAPI definitions	`query` (required), `limit` (default 10, max 50), `method` (`GET`, `POST`, etc.), `format`
`get_endpoint_details`	Retrieves the full OpenAPI specification of a given endpoint	`endpoint_id` (required), `format`

All tools accept a format parameter (markdown, json, yaml, toml), which defaults to markdown. Common workflows include:

Use search_documentation to find relevant articles, then fetch_document to get the full content.
Use search_endpoints to find API endpoints, then get_endpoint_details with the returned endpoint_id for the complete OpenAPI specification.

Usage examples

The following prompts illustrate how to use an AI assistant with the VTEX Developer MCP:


_10Search VTEX documentation for payment provider integration.


_10Fetch the full guide at https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol.


_10Find documentation about the Catalog API.


_10Search for API endpoints related to order placement.


_10Get the full specification for the Create Order endpoint.

Configuration

Configure the MCP server in the AI development tool you use.

Before you begin

Make sure you have the following:

Node.js 18 or later: Run node --version to check your installed version.
An MCP-compatible AI development tool, such as Cursor, VS Code with GitHub Copilot, Claude Code, or Claude Desktop.

Cursor

Add the server to .cursor/mcp.json in your project root, or to ~/.cursor/mcp.json for a global configuration:


_10{
_10  "mcpServers": {
_10    "vtex-developer": {
_10      "command": "npx",
_10      "args": ["-y", "@vtex/developer-mcp"]
_10    }
_10  }
_10}

VS Code / GitHub Copilot

Add the server to .vscode/mcp.json in your project root:


_10{
_10  "servers": {
_10    "vtex-developer": {
_10      "command": "npx",
_10      "args": ["-y", "@vtex/developer-mcp"],
_10      "type": "stdio"
_10    }
_10  }
_10}

VS Code uses "servers" as the top-level key, not "mcpServers".

Claude Code

Run the following command in your terminal:


_10claude mcp add vtex-developer -- npx -y @vtex/developer-mcp

Alternatively, add a .mcp.json file at your project root:


_10{
_10  "mcpServers": {
_10    "vtex-developer": {
_10      "command": "npx",
_10      "args": ["-y", "@vtex/developer-mcp"]
_10    }
_10  }
_10}

Claude Desktop

Open Claude Desktop, then go to the Claude menu → Settings... → Developer tab.
Click Edit Config to open claude_desktop_config.json.
Add the following configuration:


_10{
_10  "mcpServers": {
_10    "vtex-developer": {
_10      "command": "npx",
_10      "args": ["-y", "@vtex/developer-mcp"]
_10    }
_10  }
_10}

Quit and reopen Claude Desktop.

Troubleshooting

Node.js not installed

The server requires Node.js 18 or later. Check your version with node --version. If it's missing or outdated, install it from nodejs.org.

`npx` not found

npx ships with Node.js. Reinstall Node.js to restore it.

Server not connecting

Check that you have internet access. If you're behind a corporate firewall, make sure outbound HTTPS traffic is allowed.

Server not appearing in your MCP client

Restart your editor. Claude Desktop requires a full quit and reopen, not just a window close.

VS Code: tools not appearing

Make sure you're using "servers" (not "mcpServers") as the top-level key in .vscode/mcp.json.