变更日志服务

一个提供Shopify开发者和平台变更日志RSS源访问的MCP服务器,支持双源访问、分类过滤和统一搜索功能。

  • by damionrashford
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 damionrashford/shopify-dev-changelog-mcp

使用说明

Shopify变更日志MCP服务器

一个模型上下文协议(MCP)服务器,提供对Shopify Developer和平台变更日志RSS提要的访问。使用TypeScript构建,专为与Cursor等MCP兼容客户端集成而设计。

概述

此服务器公开了8个专门的工具,用于访问两个来源的Shopify更改日志信息:

  • 开发人员变更日志 (shopify.dev/changelog)-API更新、弃用、技术变更
  • 平台变更日志 (changelog.shopify.com)-产品更新、商家功能、UI更改

特性

  • 双源支持:访问开发人员和平台变更日志
  • 可配置源:通过环境变量启用/禁用源
  • 智能限制:从不淹没数据(每次请求最多10-30个条目)
  • 类别筛选:平台更新日志支持19+类别过滤器
  • 最近的更新:按时间段筛选(1、3、7、14或30天)
  • 统一搜索:同时搜索两个来源
  • 消息来源:明确指出每个结果来自哪个变更日志
  • 完整内容检索:需要时获取完整的帖子内容

需求

  • Node.js 18.0.0或更高版本
  • npm或兼容的包管理器

安装

  1. 克隆存储库:

    git clone https://github.com/damionrashford/shopify-changelog-mcp.git
    cd shopify-changelog-mcp
    
  2. 安装依赖项:

    npm install
    
  3. 构建项目:

    npm run build
    

配置

光标集成

添加到您的 ~/.cursor/mcp.json:

{
  "mcpServers": {
    "shopify-changelog": {
      "command": "node",
      "args": ["/path/to/shopify-changelog-mcp/dist/index.js"],
      "env": {
        "developer_changelog": "true",
        "platform_changelog": "true"
      }
    }
  }
}

环境变量

默认情况下,这两个源都处于启用状态。您可以自定义可用的源:

{
  "env": {
    "developer_changelog": "true", // Set to "false" to disable
    "platform_changelog": "true" // Set to "false" to disable
  }
}

配置示例:

两个源(默认)

// No env needed, both enabled by default
{
  "command": "node",
  "args": ["/path/to/dist/index.js"]
}

仅限开发人员

{
  "env": {
    "developer_changelog": "true",
    "platform_changelog": "false"
  }
}

仅限平台

{
  "env": {
    "developer_changelog": "false",
    "platform_changelog": "true"
  }
}

可用工具

可用的工具取决于启用了哪些源:

当两个源都启用时(默认)

开发者工具

  • dev_search -搜索开发者变更日志以获取API更新
  • dev_breaking_changes -查找突破性的更改和弃用
  • dev_recent -获取最近的开发人员更新(可配置天数)

平台工具

  • platform_search -在平台更新日志中搜索产品更新
  • platform_category -从特定类别(POS、管理员等)获取更新
  • platform_recent -获取最近的平台更新(可配置天数)

通用工具

  • get_post -获取任何更新日志帖子的完整内容
  • search_all -同时搜索两个变更日志

仅启用一个源时

当只有一个源处于活动状态时,工具使用简化名称(无前缀)。

工具详细信息

开发搜索/平台搜索

在相应的更新日志中搜索特定主题或关键字。

参数:

  • query (必填):搜索关键字
  • limit (可选):最大结果(1-30,默认值:15)

例子:

{
  "name": "dev_search",
  "arguments": {
    "query": "GraphQL mutations",
    "limit": 10
  }
}

开发中心/平台中心

获取指定时间段内的最新更新。

参数:

  • days (可选):回顾期-1、3、7、14或30(默认值:7)
  • limit (可选):最大结果(1-30,默认值:10)

例子:

{
  "name": "platform_recent",
  "arguments": {
    "days": 3,
    "limit": 15
  }
}

平台_类别

获取特定平台类别的更新。

参数:

  • category (必填):类别名称或名称数组
  • days (可选):按最近几天筛选
  • limit (可选):最大结果(1-30,默认值:10)

可用类别:

  • admin, analytics, apps, b2b, checkout
  • collective, customers, international, inventory
  • marketing, mobile, online-store, orders
  • payments, pos, products, shipping, shop, themes

例子:

{
  "name": "platform_category",
  "arguments": {
    "category": ["pos", "payments"],
    "days": 7
  }
}

开发中断更改

从开发人员更改日志中获取重大更改和弃用通知。

参数:

  • limit (可选):最大结果(1-30,默认值:15)

get_post

检索特定变更日志帖子的完整内容。

参数:

  • url (必填):变更日志帖子的完整URL

例子:

{
  "name": "get_post",
  "arguments": {
    "url": "https://shopify.dev/changelog/graphql-api-update-2024"
  }
}

search_all

在开发人员和平台变更日志中搜索。

参数:

  • query (必填):搜索关键字
  • sources (可选):要搜索的源数组(默认为全部启用)
  • limit (可选):最大总结果(1-30,默认值:15)

输出格式

所有工具都以简洁的单行格式返回格式化的结果,其中包含清晰的源属性:

1. 📘 [Developer] GraphQL Admin API: New bulk operations [API, GraphQL] | Dec 11 | https://shopify.dev/changelog/graphql-bulk-operations | The GraphQL Admin API now supports bulk operations for...
2. 🛍️ [Platform] POS: Offline mode improvements [POS, Mobile] | Dec 10 | https://changelog.shopify.com/posts/pos-offline-improvements | Point of Sale now offers enhanced offline capabilities...

发展

脚本

  • npm run build -编译TypeScript
  • npm run start -运行已编译的服务器
  • npm run dev -自动重新加载的开发模式
  • npm run clean -删除构建目录
  • npm run test -测试服务器初始化

调试模式

启用调试日志记录:

MCP_DEBUG=true npm run start