使用说明

• 项目简介

  • 该仓库实现了一个基于 MCP（Model Context Protocol）的服务端，用于门钥 Dooray 的上下文服务。它向具备自然语言处理能力的客户端（如各类 LLM）提供 Dooray 的资源、工具以及提示模板，帮助 LLM 以标准化方式访问并执行 Dooray 的功能。

• 主要功能点

  • Resources（资源）：向客户端提供可读取的上下文数据源，例如 Dooray API 信息、工作流状态、优先级参考等。
  • Tools（工具）：注册并执行大量 Dooray 相关操作的工具，例如获取任务、创建任务、更新任务、上传/读取附件、管理模板、管理标签等。
  • Prompts（프롬프트）：提供预定义的提示模板，帮助 LLM 以结构化方式发起 Dooray 相关任务（如创建任务、周报等）。
  • 通过 MCP 的标准接口处理 ListTools、ListPrompts、GetPrompt、ListResources、ReadResource、CallTool 等请求，并返回 JSON-RPC 风格的响应。
  • 支持多种传输协议（如 Stdio）以便与主流 LLM 客户端的集成。

• 安装步骤

  • 安装运行环境：Node.js 运行环境 (仓库使用 TypeScript/Node 生态)。
  • 全局安装（推荐）：
    • npm install -g @jhl8041/dooray-mcp
  • 或直接在项目中本地运行（开发模式/自定义部署方式）。
  • 运行时需要设置 Dooray API 的认证令牌：
    • DOORAY_API_TOKEN，必填，用于 Dooray API 的鉴权。
    • 如需连接到自定义 Dooray API 端点，请设置 DOORAY_API_BASE_URL。

• 服务器配置（MCP 客户端配置示例）

  • MCP 客户端需要知道需要启动的 MCP 服务器及其启动命令，并可传入参数。以下为基于仓库信息的准确示例配置（用于客户端启动该 MCP 服务器的命令与参数注释）： { "serverName": "dooray-mcp", "command": "npx @jhl8041/dooray-mcp@latest", "args": [], "env": { "DOORAY_API_TOKEN": "<발급받은 토큰>", "DOORAY_API_BASE_URL": "https://api.dooray.com" }, "description": "Dooray MCP 服务器，用于向 LLM 客户端提供 Dooray 的资源、工具与提示模板的上下文服务。启动前需将 DOORAY_API_TOKEN 设置为 Dooray 个人 API Token。" }

  • 说明：

    • serverName：服务器标识名称，客户端用于记录或管理。
    • command/args：启动服务器的命令及其参数。该实现使用 npx 安装的门槛 MCP 服务，默认不强制额外参数。
    • env：启动时传入的环境变量，最关键的是 DOORAY_API_TOKEN。若 Dooray API 基础地址与默认不同，可通过 DOORAY_API_BASE_URL 指定。
    • 如果需要通过其他客户端选项进行定制，请参考客户端工具的对接方式。

• 基本使用方法

  • 启动 MCP 服务器后，LLM 客户端将通过 MCP 的 JSON-RPC 规范向服务器请求列表（工具、提示、资源），以及调用工具来完成 Dooray 的任务操作。
  • 典型工作流包括：查询工具集与提示模板、读取资源信息、调用工具执行操作（如获取任务、创建任务、上传附件、更新任务等），服务器将返回结构化的 JSON 响应供 LLM 消费。
  • 服务器端提供日志，便于调试与监控。若需要，可通过环境变量调整日志级别。

• 基本注意事项

  • 服务器核心逻辑已实现 MCP 的核心请求处理：ListTools、ListPrompts、GetPrompt、ListResources、ReadResource、CallTool 等请求路径。
  • 服务器通过 StdioTransport 提供标准输入输出的传输方式，便于与本地或容器化环境中的 LLM 客户端对接。
  • 要确保 Dooray API 的 Token 有效且具备相应权限，否则将无法正确访问 Dooray API。