使用说明

项目简介

Ably CLI MCP Server 是 Ably CLI 的一个组件，它充当 Model Context Protocol (MCP) 服务器。该服务器允许支持 MCP 协议的 AI 工具（如 Claude 桌面版）与 Ably 平台进行交互，从而为 LLM 客户端提供实时的上下文数据和功能调用能力。

主要功能点

• 资源管理: 通过 MCP 协议提供 Ably 平台的关键资源访问，包括：
  • Channels: 列出当前 Ably 应用中的活跃频道。
  • Channel History: 获取指定频道的历史消息记录。
  • Channel Presence: 查看指定频道当前的在线成员列表。
  • Apps: 列出当前 Ably 账户下的所有应用。
  • App Stats: 获取指定 Ably 应用的统计信息。
  • App Keys: 列出指定 Ably 应用的 API 密钥。
• 工具注册: 集成了一系列预定义的工具，允许 LLM 客户端通过 MCP 协议调用 Ably CLI 的功能，包括：
  • 'list_channels': 列出活跃频道。
  • 'get_channel_history': 获取频道历史消息。
  • 'publish_to_channel': 向频道发布消息。
  • 'subscribe_to_channel': 订阅频道消息。
  • 'get_channel_presence': 获取频道在线成员。
  • 'list_apps': 列出 Ably 应用。
  • 'get_app_stats': 获取应用统计信息。
  • 'list_auth_keys': 列出应用 API 密钥。
• Stdio 传输: 使用标准输入输出 (Stdio) 作为 MCP 服务器与客户端之间通信的传输协议，简化部署和集成。

安装步骤

1. 安装 Node.js 和 npm: 确保您的系统已安装 Node.js 运行时环境和 npm 包管理器。
2. 安装 Ably CLI: 通过 npm 全局安装 Ably CLI 工具：

   npm install -g @ably/cli
   

服务器配置

为了使 MCP 客户端能够连接到 Ably CLI MCP Server，您需要在 MCP 客户端的配置中指定服务器的启动命令和参数。以下是一个典型的 JSON 格式配置示例，您需要将其填入 MCP 客户端的相应配置项中：

{
  "serverName": "Ably MCP Server",
  "command": "ably",
  "args": ["mcp", "start-server"]
}

• 'serverName': MCP 服务器的名称，您可以自定义。
• 'command': 启动 MCP 服务器的命令，这里是 'ably'，即 Ably CLI 的可执行命令。
• 'args': 传递给 'ably' 命令的参数，'["mcp", "start-server"]' 指示 Ably CLI 运行 MCP 服务器模式。

基本使用方法

1. 启动 MCP 服务器: 在安装 Ably CLI 的环境下，MCP 服务器会在您配置的 MCP 客户端尝试连接时自动启动。您无需手动运行额外的服务器程序。
2. 配置 MCP 客户端: 根据您的 MCP 客户端（例如 Claude 桌面版）的指引，配置服务器连接信息，填入上述 JSON 配置。
3. 使用 AI 工具与 Ably 交互: 在 MCP 客户端中，您可以利用 AI 工具的功能，通过自然语言指令，间接调用 Ably CLI MCP Server 提供的工具和资源，实现与 Ably 平台的交互，例如查询频道信息、发布消息、管理应用等。

注意: Ably CLI MCP Server 仍处于实验性阶段，部分功能可能不完善，请关注 Ably CLI 仓库的更新和文档。