๐Ÿ“š SHOPLINE Dev MCP

AI Assistant for SHOPLINE Development

Search docs, explore API schemas, build apps, and get up-to-date answers about SHOPLINE APIs

๐Ÿค– How It Works

Your AI assistant uses the SHOPLINE Dev MCP server to read and interact with SHOPLINE's development resources:

1๏ธโƒฃ Ask Questions

Ask your AI assistant to build something or help with SHOPLINE development tasks.

2๏ธโƒฃ Search Documentation

The assistant searches SHOPLINE documentation and API schemas based on your prompt.

3๏ธโƒฃ Get Accurate Answers

The MCP server provides accurate code, solutions, and guidance based on current APIs and best practices.

๐Ÿ“‹ Requirements

Before you set up the SHOPLINE Dev MCP server, make sure you have:

System Requirements

  • Node.js 18 or higher installed on your system
  • AI development tool that supports MCP, such as Cursor or Claude Desktop
  • Internet connection for accessing SHOPLINE documentation and APIs

Supported APIs

The MCP server provides tools to interact with the following SHOPLINE APIs:

Core APIs

  • Admin GraphQL API
  • Storefront API
  • Webhook API
  • Partner API

Additional Features

  • Sline Template Engine
  • Theme Development Tools
  • App Extensions
  • Functions (optional)

โš™๏ธ Set Up the Server

The server runs locally in your development environment and doesn't require authentication.

Step 1: Run the Server

Open a new terminal window and run the following command. Keep this terminal window open while using the server:

npx -y @shopline/dev-mcp@latest

Step 2: Configure Your AI Development Tool

Add configuration code that tells your AI tool how to connect to and use the SHOPLINE Dev MCP server. This configuration enables your AI assistant to automatically access SHOPLINE documentation, API schemas, and development guidance when you ask questions.

๐Ÿ”ง Cursor Configuration

1. Open Cursor and go to Cursor > Settings > Cursor Settings > Tools and integrations > New MCP server

2. Add this configuration to your MCP servers:

{
  "mcpServers": {
    "shopline-dev-mcp": {
      "command": "npx",
      "args": ["-y", "@shopline/dev-mcp@latest"]
    }
  }
}

For Windows, use this alternative configuration:

{
  "mcpServers": {
    "shopline-dev-mcp": {
      "command": "cmd",
      "args": ["/k", "npx", "-y", "@shopline/dev-mcp@latest"]
    }
  }
}

๐Ÿค– Claude Desktop Configuration

1. Open Claude Desktop and access your configuration file through settings

2. Add this configuration to your MCP servers section:

{
  "mcpServers": {
    "shopline-dev-mcp": {
      "command": "npx",
      "args": ["-y", "@shopline/dev-mcp@latest"]
    }
  }
}

3. Save your configuration and restart your AI development tool

๏ฟฝ Optional Advanced Configuration

The SHOPLINE Dev MCP server supports several advanced configuration options:

๐Ÿ“Š Disable Instrumentation

This package makes instrumentation calls to better understand how to improve the MCP server. To disable them, set the OPT_OUT_INSTRUMENTATION environment variable:

{
  "mcpServers": {
    "shopline-dev-mcp": {
      "command": "npx",
      "args": ["-y", "@shopline/dev-mcp@latest"],
      "env": {
        "OPT_OUT_INSTRUMENTATION": "true"
      }
    }
  }
}

๏ฟฝ Enable Sline Support

To access Sline template engine documentation and validation tools, add the SLINE flag to your MCP server configuration:

{
  "mcpServers": {
    "shopline-dev-mcp": {
      "command": "npx",
      "args": ["-y", "@shopline/dev-mcp@latest"],
      "env": {
        "SLINE": "true"
      }
    }
  }
}

๐ŸŒŸ Available Environment Variables

  • OPT_OUT_INSTRUMENTATION: Set to "true" to disable usage analytics
  • SLINE: Set to "true" to enable Sline template engine support
  • POLARIS_UNIFIED: Set to "true" to enable Polaris component documentation (experimental)
  • FUNCTIONS: Set to "true" to enable SHOPLINE Functions documentation (experimental)

๏ฟฝ๏ธ Available Tools

The SHOPLINE Dev MCP server provides the following tools to help with development:

๐Ÿ“š learn_shopline_api

Get up-to-date guidance on supported SHOPLINE APIs and how to use this MCP server's tools effectively. Provides context about which API to use for your specific needs.

Usage: Automatically invoked first when you ask about SHOPLINE APIs. It provides essential context about supported APIs and generates a conversation ID for tracking usage across tool calls.

๐Ÿ” search_docs_chunks

Search across all sline.dev documentation to find relevant information. Returns content from multiple documentation sections, but may have incomplete context due to chunking.

When used: Invoked when you ask broad questions or when the assistant needs to find relevant information across multiple documentation sections.

๏ฟฝ fetch_full_docs

Get complete documentation for specific sline.dev pages. Provides full context without information loss. Requires the exact documentation path.

When used: Used when complete documentation is needed for a specific API resource and the exact path is known.

๐Ÿ”ฌ introspect_admin_schema

Search and explore the SHOPLINE Admin API GraphQL schema to understand available types, fields, queries, and mutations.

When used: Invoked when you ask about GraphQL schema structure, available fields, or API capabilities.

โœ… validate_theme

Validate Sline templates as well as supporting theme files generated or updated by LLMs.

When used: Used after theme code was generated or modified to ensure validity and best practices.

๐Ÿ’ฌ What You Can Ask Your AI Assistant

After you set up the MCP server, you can ask your AI assistant questions like:

๐Ÿš€ API Development

  • "How do I create a product using the Admin API?"
  • "What fields are available on the Order object?"
  • "Show me an example of a webhook subscription"
  • "How do I authenticate my SHOPLINE app?"
  • "What's the difference between Admin API and Storefront API?"
  • "How do I handle pagination in GraphQL queries?"
  • "Show me bulk operation examples"
  • "What are the rate limits for SHOPLINE APIs?"

๐ŸŽจ Theme Development

  • "How do Sline templates differ from Liquid?"
  • "Validate this Sline template syntax for me"
  • "How to create loops in Sline templates?"
  • "What are the available Sline filters?"
  • "How to create a custom theme section?"
  • "What's the proper theme folder structure?"
  • "How to add theme settings and configurations?"
  • "Best practices for responsive theme design"

๐Ÿ”ง App Development

  • "How to create a SHOPLINE app from scratch?"
  • "What are the required app configurations?"
  • "How to implement OAuth for my app?"
  • "Best practices for app performance optimization"
  • "How to submit my app to the SHOPLINE App Store?"
  • "How to use SHOPLINE app extensions?"
  • "What are SHOPLINE Functions and how do I use them?"

๐Ÿ”„ Migration & Integration

  • "How to migrate from Shopify to SHOPLINE?"
  • "What are the main differences in API structure?"
  • "How to convert Liquid templates to Sline?"
  • "Integration patterns for third-party services"
  • "Data import/export best practices"
  • "How to migrate existing webhook configurations?"
  • "What tools help with platform migration?"

๐ŸŽฏ Your AI assistant will use the MCP server to search SHOPLINE's documentation when providing responses

This ensures you get accurate, up-to-date information based on current APIs and best practices.

๏ฟฝ Tips for Better AI Assistance

Get the most out of your AI assistant with these best practices:

๐ŸŽฏ Be Specific

  • Include your programming language and framework
  • Mention your specific use case or goal
  • Specify the SHOPLINE API you're working with
  • Include your current tech stack and constraints

๐Ÿ“ Request Examples

  • Ask for complete, working code snippets
  • Request step-by-step implementation guides
  • Ask for best practices and security considerations
  • Request testing and debugging strategies

๐Ÿ› Troubleshooting

  • Include full error messages and stack traces
  • Share relevant code snippets causing issues
  • Describe your expected vs actual behavior
  • Mention what you've already tried

๐Ÿ”„ Migration Help

  • Specify your current platform (e.g., Shopify)
  • Describe your existing architecture
  • Ask about equivalent SHOPLINE features
  • Request migration timeline and strategies

๐Ÿš€ Ready to Accelerate Your SHOPLINE Development?

Connect your AI assistant to SHOPLINE's development resources and start building better apps, themes, and integrations with up-to-date guidance.

View Documentation GitHub Repository

๐Ÿ”ง Technical Specifications

๐Ÿ—๏ธ Protocol Support

  • Model Context Protocol (MCP) 1.0
  • JSON-RPC 2.0 interface
  • Local server deployment
  • Cross-platform compatibility
  • Real-time documentation access

๐Ÿ“š Documentation Coverage

  • Admin GraphQL API
  • Storefront API
  • Webhook API
  • Sline Template Engine
  • Theme Development

๐Ÿ› ๏ธ Development Features

  • Real-time API schema introspection
  • Code generation and validation
  • Best practices guidance
  • Error debugging assistance
  • Migration support tools

๐Ÿค– Supported AI Tools

  • Cursor IDE with MCP support
  • Claude Desktop application
  • Any MCP-compatible AI client
  • Custom development environments
  • VS Code extensions (planned)

๐ŸŒ Multi-language Support

  • English (en)
  • ็ฎ€ไฝ“ไธญๆ–‡ (zh-CN)
  • ็น้ซ”ไธญๆ–‡ (zh-TW)
  • ๆ—ฅๆœฌ่ชž (ja)
  • ํ•œ๊ตญ์–ด (ko)
  • Bahasa Indonesia (id)
  • เน„เธ—เธข (th)
  • Tiแบฟng Viแป‡t (vi)