mcpField
E
ecardwidget-mcp

ecardwidget-mcp

本地服务
github.com/eCardWidget通信协作116 周前更新
代码仓库

关于 ecardwidget-mcp

ecardwidget-mcp 将 AI 助手连接到 eCardWidget 账户，用于管理电子贺卡、目录、组件、自动化和活动。它只注册 API 密钥权限范围内的工具，并为破坏性操作设置确认步骤。

主要功能

  1. 01搜索、创建、发送和删除电子贺卡
  2. 02管理团队成员目录
  3. 03创建和管理组件
  4. 04创建自动化与活动
  5. 05按密钥权限提供工具和提示词

适用场景

  1. 01向指定收件人发送电子贺卡
  2. 02导入或更新团队成员
  3. 03设置生日或入职自动化
  4. 04经确认后准备并发送活动

MCP 相关

MCP 服务使用权限受限的 API 密钥连接 eCardWidget，只公开该密钥允许的工具。它还为常见的多步骤流程提供引导式提示词。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "ecardwidget-ecardwidget": {
      "command": "npx",
      "args": [
        "-y",
        "ecardwidget-mcp"
      ],
      "env": {
        "ECW_API_KEY": "<ECW_API_KEY>",
        "ECW_BASE_URL": "<ECW_BASE_URL>"
      }
    }
  }
}
启动命令npx -y ecardwidget-mcp
需要配置的环境变量
ECW_API_KEY密钥Scoped eCardWidget API key (Settings → Developers → API Keys). Used as a Bearer token.
ECW_BASE_URLOverride the API base URL (default https://app.ecardwidget.com). For custom domains / testing.

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npmecardwidget-mcp0.5.2

工具

还没有获取到工具列表

本地服务需要在你的电脑上运行后才能读取工具，维护者暂未提供工具列表。

详细介绍

eCardWidget MCP 服务

npm

eCardWidget 官方 Model Context Protocol 服务。 让 AI 助手（Claude Desktop、Claude Code、Cursor、 ……）使用你的 eCardWidget 账户——搜索并发送电子贺卡、管理目录、列出 活动/小组件/自动化——使用由你生成并自行设定权限范围的 API 密钥。

助手只能执行你的 API 密钥所允许的操作。 服务启动时会向 API 查询密钥 允许执行的操作，并且仅注册该密钥权限范围内的工具。所有权限范围管控、 限流和审计都在服务端进行。

快速开始

首先，在 eCardWidget 控制面板中生成一个设定了权限范围的 API 密钥：Settings → Developers → API Keys。 只授予你希望助手操作的范围。然后选择适合你的客户端的安装方式：

选项 A — Claude Desktop（一键安装）

从最新版本 下载 ecardwidget-mcp.mcpb 并打开。Claude Desktop 会显示安装对话框，提示你输入 API 密钥（密钥将存储在操作系统 密钥链中）——无需配置文件，也无需命令。

选项 B — 登录一次，然后运行一条简短命令（Claude Code / Cursor / 任意客户端）
npx ecardwidget-mcp login          # prompts for your key, verifies + saves it locally (0600)
claude mcp add ecardwidget -- npx -y ecardwidget-mcp   # no key in the command

服务会自动读取已保存的密钥。（运行 npx ecardwidget-mcp logout 可将其删除。）

选项 C — 将密钥放入客户端配置中（手动）
{
  "mcpServers": {
    "ecardwidget": {
      "command": "npx",
      "args": ["-y", "ecardwidget-mcp"],
      "env": { "ECW_API_KEY": "YOUR_API_KEY" }
    }
  }
}

重启客户端。客户端将连接并显示密钥权限范围内的工具。优先级：显式设置的 ECW_API_KEY 环境变量始终优先于已保存的 login 凭据。

配置

变量必需默认值说明
ECW_API_KEY是—设定了权限范围的 API 密钥（用作 Bearer 令牌）。
ECW_BASE_URL否https://app.ecardwidget.com仅用于自定义域名或测试时覆盖。

工具

所有工具均使用 ecw_* 命名空间；仅注册密钥权限范围内的工具。

  • 信息查询与发现： ecw_whoami、ecw_describe_fields（可在小组件/电子贺卡/活动/自动化中设置的字段——与 OpenAPI 规范同步）
  • 电子贺卡： ecw_search_ecards、ecw_get_widget_ecards、ecw_create_ecard（通过 URL 或 base64 添加图片）、 ecw_send_ecard、ecw_delete_ecard
  • 目录： ecw_list_team_members、ecw_find_team_member、ecw_upsert_team_member、 ecw_import_team_members、ecw_deactivate_team_member、ecw_delete_team_member
  • 小组件： ecw_list_widgets、ecw_create_widget、ecw_duplicate_widget、ecw_delete_widget
  • 自动化： ecw_list_automations、ecw_create_automation（生日/周年纪念/入职）
  • 活动： ecw_list_campaigns、ecw_create_campaign（草稿）、ecw_send_campaign

具有破坏性的工具（删除、发送活动）采用两步确认——先调用一次以预览并获取一次性令牌， 然后再次提供令牌以执行操作。删除自动化/活动以及发送礼品卡活动，需要在控制面板中确认。

引导式流程（提示词）

服务提供提示词——引导式多步骤流程模板，客户端会将其显示为 斜杠命令/建议：run_campaign、setup_automation、spin_up_widget、import_directory （仅当密钥具有相应权限范围时才会显示）。连接时，它还会向助手提供一份简明的 对象模型和核心流程概览，帮助助手理解小组件、电子贺卡、活动、 自动化和目录之间的关系。

可以直接用自然语言提出请求，例如：“从我们的 Thank-You 小组件发送一张生日电子贺卡给 [email protected]。”

安全

请参阅 SECURITY.md。简而言之：采用遵循最小权限原则的密钥范围，真正的保障来自服务端强制执行，破坏性操作需要两步确认，并且绝不会记录 API key。

开发

npm install
npm run build          # tsup → dist/index.js
npm test               # vitest
npm run inspector      # MCP Inspector against the built server (needs ECW_API_KEY)

许可证

MIT

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。