JinDaGe - mcp-typebot MCP Details

article

README

🚀 MCP-Typebot

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

🚀 快速开始

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

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

✨ 主要特性

createBot
在你的工作区中创建一个新的Typebot。
必需参数：name
可选参数：workspaceId、description
listBots
列出你工作区中的所有Typebot。
可选参数：workspaceId
getBot
通过Typebot的ID获取它的信息。
必需参数：botId
updateBot
对现有的Typebot进行部分更新（例如重命名）。
必需参数：botId、typebot（包含要更改字段的对象）
可选参数：overwrite
deleteBot
通过Typebot的ID删除它。
必需参数：botId
publishBot / unpublishBot
切换Typebot的发布状态。
必需参数：botId
listResults
获取Typebot的对话结果。
必需参数：botId
可选参数：limit、cursor、timeFilter、timeZone
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"
      }
    }
  }
}

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

🔧 技术细节

前置要求

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

mcp-typebot