使用说明

项目简介

Chatwork MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在使AI智能体能够与 Chatwork 这一商务沟通工具进行交互。它将 Chatwork 的各项功能以工具 (Tools) 的形式暴露出来,供支持 MCP 协议的AI客户端调用,例如 Claude Desktop。

主要功能点

  • 获取 Chatwork 信息: 支持获取用户自身信息、联系人列表、聊天室列表等。
  • 聊天室管理: 允许AI创建、更新、删除或离开聊天室,并管理聊天室成员。
  • 消息管理: 支持AI列出、发送、标记已读/未读、更新和删除聊天室消息。
  • 任务管理: 允许AI列出、创建、获取和更新聊天室任务状态。
  • 文件和链接管理: 支持AI获取聊天室文件信息和管理聊天室邀请链接。
  • 联系人请求处理: 允许AI接受或拒绝来自他人的联系人添加请求。

安装步骤

  1. 环境准备: 确保已安装 Node.js 和 npm (或 yarn)。
  2. 克隆仓库: 使用 git 克隆仓库到本地:
    git clone https://github.com/chatwork/chatwork-mcp-server.git
  3. 进入目录: 导航到项目目录:
    cd chatwork-mcp-server
  4. 安装依赖: 安装项目所需的 npm 包:
    npm install

服务器配置

要将此 MCP 服务器连接到 MCP 客户端(例如 Claude Desktop),您需要在客户端中配置服务器设置。您需要提前准备好 Chatwork API 令牌 (Token)。

在 MCP 客户端的配置文件中 (例如 Claude Desktop 的 'claude_desktop_config.json'),添加或修改 'mcpServers' 部分,配置 Chatwork MCP Server。配置信息为 JSON 格式,示例如下:

{
  "server name": "chatwork",
  "command": "npx",
  "args": ["@chatwork/mcp-server"],
  "env": {
    "CHATWORK_API_TOKEN": "YOUR_CHATWORK_API_TOKEN" // 请替换为您的 Chatwork API 令牌
  }
}

配置参数说明:

  • 'server name': 服务器名称,可以自定义,用于在客户端中标识和引用该服务器,例如 "chatwork"。
  • 'command': 启动服务器的命令,通常为 "npx",用于执行 npm 包。
  • 'args': 命令参数,指定要执行的 npm 包名称,这里是 "@chatwork/mcp-server"。
  • 'env': 环境变量配置,用于传递服务器运行所需的敏感信息,例如 'CHATWORK_API_TOKEN',请务必替换 "YOUR_CHATWORK_API_TOKEN" 为您真实的 Chatwork API 令牌

基本使用方法

  1. 设置 API 令牌: 确保您已在服务器配置中正确设置 'CHATWORK_API_TOKEN' 环境变量。
  2. 启动服务器: 在项目根目录下,运行以下命令启动服务器:
    npm start
  3. 配置 MCP 客户端: 根据您的 MCP 客户端 (例如 Claude Desktop) 的文档,配置连接到 Chatwork MCP Server。通常需要提供上面 服务器配置 中生成的 JSON 配置信息。
  4. AI 工具调用: 配置完成后,您的 AI 工具即可使用 Chatwork MCP Server 提供的工具 (Tools) 与 Chatwork 进行交互。例如,您可以指示 AI 工具 "列出我的聊天室" 或 "发送消息到房间 [房间ID]" 等。具体的工具调用方式取决于您使用的 MCP 客户端的功能和界面。

信息

分类

通信与社交