返回 MCP 目录
public公开dns本地运行

mcp-typebot

一个MCP服务器项目,将Typebot的REST API转换为Claude Desktop可调用的工具,支持通过自然语言命令管理Typebot(创建、列表、更新、删除等)及启动聊天会话。

article

README

🚀 MCP-Typebot

MCP-Typebot是一个小型的MCP服务器,它将Typebot的REST API以可调用工具的形式集成到Claude Desktop中(通过标准输入输出)。你可以使用自然语言命令来创建、列出、获取、更新、删除、发布/取消发布Typebot,列出对话结果以及启动聊天。

🚀 快速开始

要使用MCP-Typebot,你需要完成以下几个步骤:

  1. 确保满足前置要求。
  2. 安装项目。
  3. 启动MCP服务器。
  4. 配置Claude Desktop以连接到MCP服务器。

✨ 主要特性

  • createBot
    在你的工作区中创建一个新的Typebot。
    必需参数name
    可选参数workspaceIddescription

  • listBots
    列出你工作区中的所有Typebot。
    可选参数workspaceId

  • getBot
    通过Typebot的ID获取它的信息。
    必需参数botId

  • updateBot
    对现有的Typebot进行部分更新(例如重命名)。
    必需参数botIdtypebot(包含要更改字段的对象)
    可选参数overwrite

  • deleteBot
    通过Typebot的ID删除它。
    必需参数botId

  • publishBot / unpublishBot
    切换Typebot的发布状态。
    必需参数botId

  • listResults
    获取Typebot的对话结果。
    必需参数botId
    可选参数limitcursortimeFiltertimeZone

  • startChat
    与Typebot开始一个新的聊天会话。
    必需参数botId
    可选参数chat.context

📦 安装指南

通过克隆仓库安装

git clone <repo-url>
cd mcp-typebot
npm install
npm run build

通过npm直接安装已发布的包

npm install mcp-typebot
npm start

💻 使用示例

在Claude Desktop中使用

你可以直接使用自然语言命令,例如:

用户:“帮我创建一个新的Typebot”
Claude:“当然可以,它叫什么名字?”
用户:“MyDemoBot”
Claude(内部调用):

@createBot {"name":"MyDemoBot"}

或者,你也可以显式地使用命令:

@updateBot {"botId":"<your_bot_id>","typebot":{"name":"NewName"},"overwrite":true}

你还可以启动一个聊天:

@startChat {"botId":"<your_bot_id>"}

启动服务

npm start

这将在标准输入输出上启动MCP服务器,Claude Desktop(或任何MCP客户端)将自动连接到它。

📚 详细文档

扩展功能

  • 你可以通过在src/tools/bots.ts中实现新工具,并在src/index.ts中注册它们来扩展项目功能。
  • 为每个工具定义Zod模式,以实现自动提示和验证。

配置Claude Desktop

要将Claude Desktop连接到这个MCP服务器,请在你的Claude配置文件(例如claude_desktop_config.json)中添加以下内容:

{
  "mcpServers": {
    "mcp-typebot": {
      "command": "node",
      "args": [
        "path/to/project/dist/index.js"
      ],
      "env": {
        "TYPEBOT_TOKEN": "YOUR_TOKEN_HERE",
        "TYPEBOT_WORKSPACE_ID": "YOUR_WORKSPACE_ID"
      }
    }
  }
}

请确保commandargs指向你本地构建的index.js,并且.env文件中的值与env中的值匹配。

🔧 技术细节

前置要求

  1. Node.js 18+
  2. 有效的Typebot API令牌工作区ID
  3. Claude Desktop已连接到你的本地MCP服务器
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端