使用说明

项目简介

Shopify Dev MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为 LLM 客户端提供与 Shopify 开发相关的上下文信息和功能。它集成了 Shopify 文档搜索和 Admin GraphQL Schema 检索等工具，以及用于 Shopify Admin GraphQL API 操作的 Prompt 模板，帮助开发者更高效地进行 Shopify 应用开发。

主要功能点

Shopify 文档搜索: 提供强大的 Shopify 开发文档搜索功能，帮助开发者快速找到所需的技术文档。
Admin GraphQL Schema 检索: 支持检索 Shopify Admin GraphQL API 的 Schema 信息，方便开发者理解和使用 API。
Admin GraphQL Prompt 模板: 内置 Prompt 模板，辅助开发者生成 Shopify Admin GraphQL API 的查询和变更操作。
标准 MCP 协议: 遵循 Model Context Protocol 标准，易于集成到各种支持 MCP 协议的 LLM 客户端。
Stdio 传输协议: 使用 Stdio 作为传输协议，部署和运行简单方便。

安装步骤

确保 Node.js 环境: 请确保您的开发环境中已安装 Node.js 和 npm (或 npx)。
全局安装 (可选): 您可以使用 npm 全局安装 '@shopify/dev-mcp' 包，以便在任何地方直接运行 'shopify-dev-mcp' 命令：
```
npm install -g @shopify/dev-mcp
```
使用 npx 运行 (推荐): 或者，您可以使用 'npx' 命令，无需全局安装即可直接运行最新版本的 Shopify Dev MCP Server：
```
npx -y @shopify/dev-mcp@latest
```

服务器配置

MCP 服务器是为 MCP 客户端设计的，您需要在支持 MCP 协议的 LLM 客户端中配置 Shopify Dev MCP Server 的启动信息。以下是配置示例 (JSON 格式)，通常在客户端的 MCP 服务器配置中添加：

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

配置参数说明:

'"mcpServers"': 根配置项，用于定义所有的 MCP 服务器。
'"shopify-dev-mcp"': 服务器名称，这个名称将用于在客户端中引用和选择此服务器。
'"command"': 启动服务器的命令。 'npx' 是 Node.js 的包运行器，用于执行包命令，这里用来运行 '@shopify/dev-mcp' 包。
'"args"': 传递给启动命令的参数列表。
- '"-y"': 'npx' 的参数，表示自动同意安装包，无需交互确认。
- '"@shopify/dev-mcp@latest"': 指定要运行的 npm 包及其版本，'@latest' 表示使用最新版本。

Windows 系统配置 (如果上述配置无法工作):

在 Windows 系统中，您可能需要通过 'cmd' 命令来调用 'npx'，配置如下：

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

'"cmd"': Windows 命令解释器。
'"/k"': 'cmd' 的参数，表示执行后面的命令后保持窗口打开。

基本使用方法

启动服务器: 根据安装步骤，在命令行中运行 'npx -y @shopify/dev-mcp@latest' 或全局安装后运行 'shopify-dev-mcp' 启动服务器。服务器成功启动后，会在控制台输出 "Shopify Dev MCP Server v[版本号] running on stdio"。
配置客户端: 将上述提供的 JSON 配置添加到您的 MCP 客户端（如 Cursor 或 Claude Desktop）的 MCP 服务器配置中，并确保服务器名称与配置中的 '"shopify-dev-mcp"' 一致。
在客户端中使用: 客户端连接到 Shopify Dev MCP Server 后，您就可以在客户端中使用以下功能：
- 使用 'search_dev_docs' 工具搜索 Shopify 开发文档。
- 使用 'introspect_admin_schema' 工具检索 Shopify Admin GraphQL Schema 信息。
- 使用 'shopify_admin_graphql' Prompt 模板生成 Shopify Admin GraphQL API 操作。

具体工具和 Prompt 的使用方法请参考您使用的 MCP 客户端的文档。

关键词