使用说明(Markdown 格式)

  • 项目简介

    • Meow Notifier MCP Server 是一个基于 Node.js/TypeScript 的 MCP 服务器实现。它通过标准的 MCP 客户端/服务器方式,暴露一个可调用的工具(send_notification)并提供引导提示(prompt),以便与 LLM 客户端进行资源访问、工具执行和提示渲染等交互。核心能力包括对多个 nickname 的并发通知发送、可扩展的工具集以及提示模板的渲染与使用。
  • 主要功能点

    • MCP 服务器实现:支持使用标准的 MCP JSON-RPC 交互,通过注册工具和提示来扩展能力,并通过标准传输(如 STDIO)与 MCP 客户端通信。
    • 多昵称支持:通过 MEOW_NICKNAMES 环境变量配置多个接收目标 nickname,支持 JSON 数组格式或逗号分隔格式,运行时会对所有配置的 nickname 并发发送通知。
    • 工具(Tools):注册 send_notification 工具,提供 message、title、url、msgType、htmlHeight 等参数,参数直接传递给后端通知接口。
    • 提示模板(Prompts):提供 send_notification_guide 提示,用于引导 LLM 了解如何使用 send_notification 工具。
    • 运营方式:可以通过 npx 直接运行,也可作为 MCP 服务器在本地开发环境中使用。
  • 安装步骤

    • 环境要求:需要 Node.js 环境(通常建议 Node.js 14+ 及以上版本)。
    • 安装依赖并构建(如有构建步骤):
      • 运行 npm install 以安装依赖。
      • 如项目提供构建脚本,执行 npm run build 进行构建。
    • 运行方式(推荐直接通过 npx):
      • 设置环境变量并启动:MEOW_NICKNAMES="nickname1,nickname2" npx meow-notifier
      • 或先导出环境变量再启动:export MEOW_NICKNAMES="nickname1,nickname2"; npx meow-notifier
    • 作为 MCP 服务器使用(可与 MCP 客户端对接):
      • 通过 MCP 客户端的配置,使用 meow-notifier 作为服务器端进程,示例配置中可包含以下字段(不需要代码块,仅描述字段含义):
        • server name: meow-notifier
        • command: npx
        • args: ["-y", "meow-notifier"]
        • env: MEOW_NICKNAMES 设置,格式可为 JSON 字符串表示的数组或逗号分隔的字符串,例如 MEOW_NICKNAMES: "["nickname1", "nickname2"]" 或 "nickname1,nickname2"
        • timeout: 60
        • alwaysAllow: ["send_notification"]
      • 具体 MCP 客户端的使用请参考 MCP 客户端文档,但核心是让 MCP 客户端能够通过上述服务器命令启动并与服务端建立通信。
  • 基本使用方法

    • 发送通知(对所有配置的 nickname):
      • 通过 send_notification 工具调用,支持直接传入 message、url、title、msgType、htmlHeight。服务端会对每个 nickname 并发发送通知,并返回逐条的成功/失败结果。
    • 查看帮助/版本:
      • 运行时支持 --version/-v 参数查看版本信息(与仓库实现相关的版本读取逻辑绑定在 package.json)。
    • 访问帮助提示:
      • 使用 send_notification_guide 提示,了解如何正确使用 send_notification 工具及参数含义。
  • 服务器配置(MCP 客户端需要的配置信息说明,非代码块描述)

    • server name(服务器标识): meow-notifier
    • command(启动命令): npx
    • args(命令参数列表): ["-y", "meow-notifier"]
    • env(环境变量): { MEOW_NICKNAMES: 设置为 JSON 字符串表示的昵称数组,例如 "["nickname1", "nickname2"]" 或 "nickname1,nickname2" }
    • timeout(超时时间,秒): 60
    • alwaysAllow(允许的工具列表): ["send_notification"]
    • 备注:MCP 客户端不需要额外的代码,只需按照上述字段启动服务器进程并通过 MCP 绑定的传输通道进行通信。
  • 其他注意

    • MEOW_NICKNAMES 至少应配置一个昵称,否则无法发送通知。
    • JSON 格式中的引号需要转义(如通过 JSON 字符串传入的 MEOW_NICKNAMES)。
    • 支持多接收者并发发送,返回包含每个 nickname 的详细结果。

信息

分类

网页与API