使用说明

项目简介

ToolJet MCP (Model Context Protocol) 是一个 MCP 服务器实现，它充当 AI 助手（如 Claude、Cursor 等 MCP 客户端）与 ToolJet 平台之间的桥梁。通过 ToolJet MCP，AI 助手可以安全地访问 ToolJet 实例中的数据和功能，实现更智能的自动化工作流程。

主要功能点

用户和工作区管理: 提供工具让 AI 助手可以查询、创建和管理 ToolJet 平台的用户和工作区。例如，AI 助手可以列出所有用户、创建新用户或检索特定工作区的信息。
应用信息访问: 允许 AI 助手获取 ToolJet 应用程序的相关信息，例如列出特定工作区中的所有应用。
管理任务执行: 支持 AI 助手执行 ToolJet 平台上的管理任务，例如更新用户信息、更改用户角色等。
可扩展性: 基于 MCP 标准协议构建，易于集成到支持 MCP 的各种 AI 助手平台。

安装步骤

安装 Node.js: 确保您的系统已安装 Node.js (v14 或更高版本)。
安装 ToolJet MCP: 打开终端，运行以下命令全局安装 ToolJet MCP 包：
```
npm install -g @tooljet/mcp
```
获取 ToolJet 访问令牌: 登录您的 ToolJet 实例，获取具有管理员权限的访问令牌。您需要在 MCP 服务器配置中使用此令牌进行身份验证。请参考 ToolJet API 文档了解如何启用和获取 API 访问令牌。

服务器配置

为了让 MCP 客户端（如 AI 助手）连接到 ToolJet MCP 服务器，您需要在客户端配置中指定服务器的启动命令和相关参数。以下是一个典型的 JSON 配置示例，您需要根据您的实际环境进行调整：

{
  "mcpServers": {
    "tooljet": {
      "command": "npm",
      "args": ["@tooljet/mcp"],
      "env": {
        "TOOLJET_ACCESS_TOKEN": "YOUR_TOOLJET_ACCESS_TOKEN",  // 替换为您的 ToolJet 访问令牌
        "TOOLJET_HOST": "YOUR_TOOLJET_INSTANCE_URL"        // 替换为您的 ToolJet 实例 URL，例如 "https://your-tooljet-instance.com"
      }
    }
  }
}

配置参数说明:

'"tooljet"': 服务器名称，您可以自定义。
'"command": "npm"': 启动服务器的命令，这里使用 'npm'。
'"args": ["@tooljet/mcp"]': 传递给 'npm' 命令的参数，指定要执行的 ToolJet MCP 包。
'"env"': 环境变量配置。
- '"TOOLJET_ACCESS_TOKEN": "YOUR_TOOLJET_ACCESS_TOKEN"': 必填。ToolJet 访问令牌，用于 MCP 服务器向 ToolJet API 进行身份验证。请替换为您的实际访问令牌。
- '"TOOLJET_HOST": "YOUR_TOOLJET_INSTANCE_URL"': 必填。您的 ToolJet 实例的 URL 地址。请替换为您的实际 ToolJet 实例 URL。

Windows 用户注意: 如果您在 Windows 系统上使用，可能需要在 'command' 中添加 'cmd /c' 前缀，例如：

{
  "mcpServers": {
    "tooljet": {
      "command": "cmd",
      "args": [
        "/c",
        "npm",
        "@tooljet/mcp"
      ],
      "env": {
        "TOOLJET_ACCESS_TOKEN": "YOUR_TOOLJET_ACCESS_TOKEN",
        "TOOLJET_HOST": "YOUR_TOOLJET_INSTANCE_URL"
      }
    }
  }
}

基本使用方法

配置完成后，您的 AI 助手就可以通过 ToolJet MCP 服务器与 ToolJet 平台进行交互了。您可以指示 AI 助手执行以下类型的操作：

查询用户: 例如，您可以询问 AI 助手 "Show me all users in my ToolJet instance" (显示我 ToolJet 实例中的所有用户)。
创建用户: 例如，您可以指示 AI 助手 "Create a new user named John Doe in the Marketing workspace" (在 Marketing 工作区创建一个名为 John Doe 的新用户)。
查询应用: 例如，您可以询问 AI 助手 "List all the apps in the Development workspace" (列出 Development 工作区中的所有应用)。
更新用户角色: 例如，您可以指示 AI 助手 "Update the role of [email protected] to Admin in the Sales workspace" (将 [email protected] 在 Sales 工作区中的角色更新为管理员)。

请参考 ToolJet MCP 提供的工具列表，结合您的 AI 助手的具体使用方法，即可开始使用 ToolJet MCP 提供的各项功能。

关键词