rework-mcp-server

Rework MCP 服务

用于将 Rework 平台集成到 AI 应用中的模型上下文协议（MCP）服务。此服务允许 AI Agent 通过标准化协议与 Rework 项目、任务、工作流和工作项进行交互。

🚀 状态更新： v0.7.2 现已发布，完整支持项目管理和工作流。

设置

1. 获取 Rework 凭据：
   • 从 Rework 平台设置中获取 API 密钥
   • 从你的 Rework 账户中获取工作区信息
2. 使用你的凭据配置 MCP 服务
3. 使用自然语言管理你的项目和工作流！

安装

将此条目添加到客户端的 MCP 设置 JSON 文件中：

{
  "mcpServers": {
    "Rework": {
      "command": "node",
      "args": [
        "index.js"
      ],
      "env": {
        "REWORK_API_KEY": "your-api-key",
        "REWORK_WORKSPACE_ID": "your-workspace-id"
      }
    }
  }
}

或者，你可以使用 Node 直接运行服务：

node index.js --env REWORK_API_KEY=your-api-key --env REWORK_WORKSPACE_ID=your-workspace-id

你可以使用 DISABLED_TOOLS 环境变量禁用特定工具。提供要禁用的工具名称列表，并以逗号分隔（例如，create_task,get_tasks）。

如果工具数量或上下文限制导致问题，请禁用不需要的工具。

使用 SSE 支持运行

设置以下环境变量，即可在 SSE（服务器发送事件）模式下运行服务：

{
  "mcpServers": {
    "Rework": {
      "command": "node",
      "args": [
        "index.js"
      ],
      "env": {
        "REWORK_API_KEY": "your-api-key",
        "REWORK_WORKSPACE_ID": "your-workspace-id",
        "ENABLE_SSE": "true",
        "PORT": "8000"  // Optional, defaults to 3000
      }
    }
  }
}

也可以通过命令行运行：

node index.js --env REWORK_API_KEY=your-api-key --env REWORK_WORKSPACE_ID=your-workspace-id --env ENABLE_SSE=true --env PORT=8000

Docker 部署

version: '3.8'

services:
  rework-mcp-server:
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - '3000:8000'
    environment:
      - REWORK_API_KEY=${REWORK_API_KEY}
      - REWORK_WORKSPACE_ID=${REWORK_WORKSPACE_ID}
      - ENABLE_SSE=true
      - LOG_LEVEL=info
    volumes:
      - ./src:/app/src
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 5s

功能

📝 项目管理	🔄 工作流管理
• 创建和管理任务 • 查看任务详情 • 列出项目中的任务 • 为任务添加评论 • 在项目中整理任务 • 查看任务状态和进度	• 创建和管理工作项 • 跟踪工作项状态 • 查看工作项详情 • 按工作流列出工作项 • 整理工作流 • 将工作项关联到工作流

👥 用户管理	⚡ 集成功能
• 按姓名或电子邮件查找用户 • 列出所有可用用户 • 将用户分配给任务 • 查看用户信息 • 用户身份验证 • 管理用户权限	• 基于 ID 和名称的查询 • 支持 Markdown 内容 • 内置错误处理 • API 速率限制 • 输入验证 • 全面的 API 覆盖

可用工具

工具	描述	必需参数
项目管理
create_task	在项目中创建任务	name、board_id、creator_username
get_tasks	获取看板中的任务	board_id 和可选筛选条件
get_detail_task	获取任务的详细信息	id
get_projects	获取所有项目和看板	可选搜索查询 q
工作流管理
create_job	在工作流中创建工作项	name、workflow_id、creator_username
get_jobs	获取工作流中的工作项	workflow_id 和可选筛选条件
get_detail_job	获取工作项的详细信息	id
get_workflows	获取所有可用工作流	可选搜索查询 q
用户管理
find_users	按姓名或电子邮件查找用户	q（搜索查询）、properties
list_all_users	获取工作区所有成员	无

可参阅项目文档，了解可选参数和高级用法。

用户管理

创建任务或作业时，可以使用 user_id 参数分配用户。此外，还需要指定 creator_username，以表明是谁创建了该任务或作业：

{
  "name": "🚀 New Feature Implementation",
  "board_id": "board_123",
  "content": "Implement the new feature described in the spec",
  "creator_username": "jane.doe",
  "user_id": "user_456"
}

用户管理工具可帮助你按姓名或电子邮件查找用户，并获取其 ID 以分配任务。

错误处理

Rework MCP 服务会针对以下情况提供清晰的错误消息：

• 缺少必需参数
• ID 或引用无效
• 未找到资源
• 身份验证失败
• 权限问题
• API 错误
• 请求速率限制

可以指定 LOG_LEVEL 环境变量来控制服务日志的详细程度。有效值为 trace、debug、info、warn 和 error（默认值）。 也可以在命令行中指定：--env LOG_LEVEL=info。

自定义字段支持

创建任务和作业时，都可以通过 custom_fields 参数支持自定义字段。该参数接受一个对象数组，每个对象包含 id 和 value 属性：

{
  "custom_fields": [
    {
      "id": "custom_field_123",
      "value": "High Priority"
    },
    {
      "id": "custom_field_456",
      "value": true
    }
  ]
}

参与贡献

欢迎贡献！请随时提交 Pull Request。

许可证

本项目采用 MIT License 许可，详情请参阅 LICENSE 文件。

免责声明

本软件使用 Rework API。所有商标和品牌名称均为其各自所有者的财产。本项目与 Rework 没有官方关联，也未获得 Rework 的认可。