Source code

@vtex/developer-mcp is a Model Context Protocol (MCP) server that enables AI coding assistants to access VTEX documentation and API references. It provides a standardized interface for retrieving documentation content and API specifications directly from development tools such as editors or AI assistants.

Once connected, your AI assistant can:

• Search VTEX documentation
• Retrieve full documentation articles
• Search API endpoints based on OpenAPI definitions
• Retrieve detailed endpoint specifications

These capabilities allow AI assistants to generate responses based on up-to-date VTEX content.

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.

Follow the instructions for your development environment.

Add the server to .cursor/mcp.json in your project root (or ~/.cursor/mcp.json for a global config):

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

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

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

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

Run the following command in your terminal:

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

Or add a .mcp.json file at your project root:

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

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

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

4. Quit and reopen Claude Desktop.

Once connected, your AI assistant has access to four tools:

Tool	Description	Key parameters
search_documentation	Searches VTEX Help Center and Developer Portal content (provides hybrid semantic and keyword search across VTEX Help Center and Developer Portal)	query (required), locale (en, es, pt — required), limit (1–50), format
fetch_document	Retrieves the full content of a VTEX documentation article by URL	url (required), format
search_endpoints	Searches VTEX API endpoints by query over OpenAPI definitions	query (required), limit (1–50), method (GET, POST, etc.), format
get_endpoint_details	Retrieves the full OpenAPI specification of a given endpoint	endpoint_id (required), format

A few tips on how to combine them:

• 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 for the complete OpenAPI specification.
• All tools support a format parameter (markdown, json, yaml, toml) — defaults to markdown.

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

• "Search VTEX documentation for payment provider integration"
• "Fetch the full guide at https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol"
• "Find documentation about the Catalog API"
• "Search for API endpoints related to order placement"
• "Get the full specification for the Create Order endpoint"

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 get it back.

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.