Shopify Dev MCP 服务器

本项目实现了一个与 Shopify Dev 交互的模型上下文协议（MCP）服务器，支持通过多种工具对接不同的 Shopify API。目前支持以下 API：

• Admin GraphQL API
• Functions API（可选）
• Polaris Web Components（北极星 Web 组件）

可用工具

可用提示词（Prompts）

核心功能场景

1. 文档检索与开发支持

   • 通过 search_dev_docs 和 fetch_docs_by_path 快速定位官方文档，获取 API 参考、开发指南和最佳实践。
   • 示例：检索“Shopify Functions API 身份验证”相关文档，或直接获取 /api/2023-10/functions 路径下的内容。

2. GraphQL 模式探索

   • 使用 introspect_admin_schema 工具查询 Admin GraphQL API 的完整模式，包括对象类型、字段、枚举值等，辅助构建复杂查询。
   • 场景：调试 GraphQL 查询时，动态获取 Product、Order 等对象的字段定义，避免硬编码错误。

3. 快速入门引导

   • get_started 工具提供新手引导，涵盖 API 密钥创建、权限配置、第一个请求示例等，降低入门门槛。

4. GraphQL 操作辅助

   • 通过 shopify_admin_graphql 提示词，结合自然语言描述生成可执行的 GraphQL 代码片段，例如：

                         
     graphql
     
                         # 提示词：查询店铺当前在线产品数量及库存状态  
     query GetProductInventory {  
       products(first: 10) {  
         edges {  
           node {  
             title  
             variants(first: 1) {  
               edges {  
                 node {  
                   sku  
                   inventoryQuantity  
                 }  
               }  
             }  
           }  
         }  
       }  
     }  
     

集成与使用建议

1. 开发流程

   • 通过 MCP 客户端调用工具，例如使用 fetch_docs_by_path 获取特定文档路径的内容：

                         
     json
     
                         {  
       "name": "fetch_docs_by_path",  
       "arguments": {  
         "path": "/apps/functions/building"  // 获取 Functions API 开发指南  
       }  
     }  
     

   • 结合提示词生成 GraphQL 操作，减少手动编写代码的复杂度。

2. 权限与认证

   • 使用 Shopify 开发者账号获取 API 密钥，并通过 MCP 协议传递认证信息（具体认证方式需参考服务器配置文档）。

3. 适用场景

   • 适用于 Shopify 应用开发者、技术团队快速构建集成 Shopify 功能的应用，尤其适合需要频繁查阅文档、调试 GraphQL 查询的场景。

优势与价值

• 效率提升：通过工具化和自然语言提示，减少文档检索和代码编写时间。
• 准确性保障：直接对接官方 API 模式和文档，避免过时信息导致的开发错误。
• 低门槛接入：无需深入记忆 API 细节，通过交互式工具引导完成开发任务。