AI导哈

模型上下文协议服务器

一个用于将Rework平台与AI应用集成的模型上下文协议服务器，支持通过标准化协议管理项目、任务和工作流。

  • by caobo171
  • TypeScript
  • 混合部署
  • 更新于
在 GitHub 查看 caobo171/rework-mcp-server

使用说明

返工MCP服务器

用于将Rework平台与AI应用程序集成的模型上下文协议（MCP）服务器。该服务器允许AI代理通过标准化协议与返工项目、任务、工作流和作业进行交互。

🚀 状态更新： v0.7.2现在提供完整的项目管理和工作流支持。

设置

  1. 获取您的返工证书：
    • 返工平台设置中的API密钥
    • 来自您的返工帐户的工作区信息
  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以进行任务分配。

错误处理

返工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
    }
  ]
}

贡献

欢迎投稿！请随时提交拉取请求。

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

免责声明

此软件使用返工API。所有商标和品牌名称均为其各自所有者的财产。该项目与返工没有正式关联或认可。

相关 MCP