API ReferenceGuides
Log In
API Reference

MCP

What is MCP?

Model Context Protocol (MCP) is an open standard that lets AI assistants access external tools and documentation in real time. The Swym Developer Docs MCP server gives your AI coding assistant direct access to:

  • Environment setup guide — Shopify CLI, theme pull, theme detection
  • JS SDK quickstart — SwymCallbacks pattern, product data shape, identity sync
  • Full API reference — All public _swat methods, signatures, and events
  • Component guides — PDP wishlist button, collection page buttons, wishlist page, header icon
  • Code standards — JavaScript, CSS, Liquid, accessibility, and security rules from 1,955+ code review comments
  • Complete implementation plan — Build order, conversion patterns, and best practices

Remote MCP Server

The Swym Dev Docs MCP is hosted at:

https://developers.getswym.com/mcp

No authentication required. Configure your AI tool below.


Cursor

Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "swym-dev-docs": {
      "url": "https://developers.getswym.com/mcp"
    }
  }
}

Restart Cursor after saving.


Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "swym-dev-docs": {
      "serverUrl": "https://developers.getswym.com/mcp"
    }
  }
}

Restart Windsurf after saving.


Claude Desktop

Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "swym-dev-docs": {
      "url": "https://developers.getswym.com/mcp"
    }
  }
}

Restart Claude Desktop after saving.


Claude Code (CLI)

Run:

claude mcp add swym-dev-docs https://developers.getswym.com/mcp

Or add to .claude/settings.json:

{
  "mcpServers": {
    "swym-dev-docs": {
      "url": "https://developers.getswym.com/mcp"
    }
  }
}

VS Code (Copilot Chat)

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

{
  "servers": {
    "swym-dev-docs": {
      "url": "https://developers.getswym.com/mcp",
      "type": "http"
    }
  }
}

Available Tools

Once connected, your AI assistant can call these tools:

ToolDescription
get-setup-guideShopify CLI install, theme pull, theme architecture detection
get-sdk-quickstartSDK-only mode, SwymCallbacks pattern, product data shape
get-api-referenceAll public _swat methods, signatures, events
get-complete-js-sdk-setupFull implementation plan with build order and conversion patterns
get-code-standardsJS, CSS, Liquid, a11y, and security rules
get-wishlist-button-guidePDP button — Liquid markup, JS with variant handling, styling
get-collection-buttons-guideCollection buttons — selectors, variant resolution, MutationObserver
get-wishlist-page-guideWishlist page — theme-native cards, login nudge, remove + ATC

Testing Your Setup

  1. Open your AI editor
  2. Start a new chat and try:
    • "Set up Swym wishlist end to end experience on my Dawn theme and match my theme"
    • "Add a wishlist button to my PDP"
    • "Show me all available swat API methods"
    • "What are Swym's code standards for Liquid files?"
  3. The assistant should pull live documentation from the MCP server to answer