使用说明

项目简介

'monday.com API MCP服务器' 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在简化AI智能体与 monday.com 平台的集成。它允许LLM客户端通过标准化的MCP协议，安全、便捷地访问和操作 monday.com 的数据和功能。该服务器将 monday.com API 封装成一系列易于LLM调用的工具，使得开发者可以快速构建基于 monday.com 的AI应用。

主要功能点

MCP服务器核心功能: 实现了MCP协议，可以作为LLM客户端的后端，提供上下文服务。
资源访问: 虽然仓库本身没有明确的“资源”概念，但通过提供的工具可以访问和操作monday.com的数据，如项目、任务、用户等，这些可以被视为托管的资源。
工具注册与执行: 内置了丰富的工具集，覆盖了 monday.com API 的常用操作，例如创建、读取、更新、删除项目、任务、列等。LLM客户端可以调用这些工具来执行monday.com平台上的操作。
动态API工具: 支持动态API工具功能（Beta），可以根据monday.com API schema 提供更全面的API能力。
Prompt模板: 仓库中没有直接定义Prompt模板，但作为MCP服务器，它可以支持Prompt模板的定义和渲染，以便定制LLM交互模式 (需要基于工具能力手动配置Prompt)。
多种传输协议支持: 使用 '@modelcontextprotocol/sdk/server/stdio.js' 实现了 Stdio 传输协议，可以通过标准输入输出与客户端通信。
易于集成: 设计为易于与各种MCP客户端（如 Cursor 和 Claude Desktop）集成，通过 NPX 即可运行。
安全与可扩展: 通过 MCP 框架提供安全、可扩展的上下文服务，API Token 等敏感信息通过环境变量或命令行参数配置，提高安全性。

安装步骤

前提条件:
- Node.js 和 npm (或 yarn) 环境。
- 拥有 monday.com 账户和 API Token。
安装 monday-api-mcp: 打开终端，使用 npm 或 yarn 全局安装 '@mondaydotcomorg/monday-api-mcp' 包 (实际上更推荐直接使用 'npx' 运行，无需全局安装，以下使用 'npx' 方式)：
```
# 无需安装，直接使用 npx 运行
```

服务器配置

MCP 客户端需要配置服务器的启动命令及其参数才能连接。以下是 'monday.com API MCP服务器' 的配置信息示例 (JSON 格式):

{
  "serverName": "monday-api-mcp",
  "command": "npx",
  "args": [
    "@mondaydotcomorg/monday-api-mcp",
    "--token", "<YOUR_MONDAY_API_TOKEN>",
    "--version", "v2"  // 可选: 指定 monday.com API 版本，默认为最新版本
    // "--read-only"     // 可选: 启用只读模式，禁止执行变更操作
    // "--enable-dynamic-api-tools" // 可选 (Beta): 启用动态API工具，包含完整API schema，与只读模式互斥
  ],
  "notes": "请将 <YOUR_MONDAY_API_TOKEN> 替换为您的 monday.com API Token。版本参数 (version)、只读模式 (read-only) 和动态API工具 (enable-dynamic-api-tools)  为可选参数，可以根据需要配置。"
}

参数说明:

'serverName': 服务器名称，可以自定义，用于在客户端标识服务器。
'command': 启动服务器的命令，这里使用 'npx'。
'args': 传递给 'npx' 命令的参数列表，包括：
- '@mondaydotcomorg/monday-api-mcp': 指定要运行的 npm 包。
- '--token <YOUR_MONDAY_API_TOKEN>' (或 '-t <YOUR_MONDAY_API_TOKEN>') (必填): monday.com API Token。请务必替换为您的真实Token! 您也可以将 Token 设置为环境变量 'MONDAY_TOKEN'，此时可以省略此参数。
- '--version <API_VERSION>' (或 '-v <API_VERSION>') (可选): monday.com API 版本，例如 'v2'。默认为最新版本。
- '--read-only' (或 '-ro') (可选): 启用只读模式。启用后，服务器将只允许执行查询操作，禁止执行任何修改 monday.com 数据的操作（例如创建、更新、删除）。
- '--enable-dynamic-api-tools' (或 '-edat') (可选, Beta): 启用动态API工具。启用后，服务器将包含完整的 monday.com GraphQL API schema，提供更全面的API能力。注意：此模式与 '--read-only' 互斥，不能同时启用。
'notes': 配置说明和注意事项。

环境变量配置 (可选):

除了命令行参数，您还可以通过环境变量配置 API Token 和 API 版本：

'MONDAY_TOKEN': 设置 monday.com API Token。
'MONDAY_VERSION': 设置 monday.com API 版本。

如果设置了环境变量，则在 'args' 中可以省略 '--token' 和 '--version' 参数。

基本使用方法

启动 MCP 服务器: 在配置好 MCP 客户端后，客户端会根据您提供的 'command' 和 'args' 启动 'monday.com API MCP服务器' 进程。
客户端与服务器通信:
- MCP 客户端通过 Stdio 协议与 'monday.com API MCP服务器' 进行通信。
- 客户端可以向服务器发送 JSON-RPC 请求，例如调用已注册的工具 (Tools) 来查询或操作 monday.com 数据。
- 服务器接收请求后，会调用相应的 monday.com API，并将结果以 JSON-RPC 响应的形式返回给客户端。
使用内置工具 (Tools): 'monday.com API MCP服务器' 预置了丰富的工具，例如：
- 'get_board_items_by_name': 根据名称和版块ID获取项目。
- 'create_item': 在 monday.com 版块中创建新项目。
- 'change_item_column_values': 更改 monday.com 项目的列值。
- 'get_users_by_name': 根据名称获取用户信息。
- 'create_update': 在 monday.com 项目中创建更新。
- ... 以及更多工具，覆盖了 monday.com API 的常用功能。
LLM 客户端可以通过工具名称和参数调用这些工具，从而实现与 monday.com 的交互。具体的工具列表和参数定义可以参考 'packages/agent-toolkit/src/core/platform-api-tools/' 目录下的代码。

注意: 请确保您的 monday.com API Token 具有足够的权限，以便服务器能够执行您期望的操作。

关键词