typebot-mcp
v1.0.3
Published
[](https://smithery.ai/server/@hithereiamaliff/typebot-mcp)
Maintainers
Readme
Typebot MCP Server
A small MCP server that exposes Typebot’s REST API as callable tools in Claude Desktop (via STDIO). You can create, list, get, update, delete, publish/unpublish Typebots, list results, and start chats—using natural-language commands.
Features
createBot
Create a new Typebot in your workspace.
Required:name
Optional:workspaceId,descriptionlistBots
List all Typebots in your workspace.
Optional:workspaceIdgetBot
Fetch a Typebot by its ID.
Required:botIdupdateBot
Patch an existing Typebot (e.g. rename).
Required:botId,typebot(object with fields to change)
Optional:overwritedeleteBot
Delete a Typebot by its ID.
Required:botIdpublishBot / unpublishBot
Toggle a Typebot’s published state.
Required:botIdlistResults
Retrieve conversation results for a Typebot.
Required:botId
Optional:limit,cursor,timeFilter,timeZonestartChat
Begin a new chat session with a Typebot.
Required:botId
Optional:chat.context
Prerequisites
- Node.js 18+
- A valid Typebot API token and workspace ID
- Claude Desktop connected to your local MCP server
Installation
Option 1: Clone the repository
git clone <repo-url>
cd typebot-mcp
npm install
npm run buildOption 2: Install via npm
npm install typebot-mcp
npm startOption 3: Install via Smithery
You can easily install this MCP server through Smithery:
- Visit https://smithery.ai/server/@hithereiamaliff/typebot-mcp
- Follow the installation instructions on the Smithery page
- Configure your environment variables as described in the Deployment Options section
Running
npm startUsage in Claude Desktop
Simply write natural commands like:
User: “Create me a new typebot”
Claude: “Sure—what name?”
User: “MyDemoBot”
Claude (internally invokes):@createBot {"name":"MyDemoBot"}
Or, explicitly:
@updateBot {"botId":"<your_bot_id>","typebot":{"name":"NewName"},"overwrite":true}You can also start a chat:
@startChat {"botId":"<your_bot_id>"}Extending
- Add new tools by implementing them in
src/tools/bots.tsand registering them insrc/index.ts. - Define a Zod schema for each tool to get automatic prompting and validation.
Deployment Options
Local Configuration (Claude Desktop)
To connect Claude Desktop to this MCP server locally, add the following to your Claude configuration (e.g. claude_desktop_config.json):
{
"mcpServers": {
"typebot-mcp": {
"command": "node",
"args": [
"path/to/project/dist/index.js"
],
"env": {
"TYPEBOT_TOKEN": "YOUR_TOKEN_HERE",
"TYPEBOT_WORKSPACE_ID": "YOUR_WORKSPACE_ID",
"TYPEBOT_API_URL": "YOUR_TYPEBOT_API_URL"
}
}
}
}Make sure the command and args point to your local built index.js, and that your environment variables are correctly set.
Smithery Deployment
To deploy this MCP server on Smithery:
- Push your code to a GitHub repository
- Log into your Smithery account
- Create a new deployment and connect it to your GitHub repository
- Configure the following environment variables in Smithery:
TYPEBOT_TOKEN: Your Typebot API tokenTYPEBOT_WORKSPACE_ID: Your Typebot workspace IDTYPEBOT_API_URL: The URL to your Typebot API (e.g., https://your-typebot-instance.com/api/v1)
- Deploy the application
- Use the provided URL to connect Claude to your MCP server
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgements
This project is a direct fork of osdeibi's MCP-typebot. It builds upon the original work with the following improvements:
- Configurable API URL: Added support for custom Typebot API endpoints via the
TYPEBOT_API_URLenvironment variable instead of hardcoded URLs - Improved Error Handling: Enhanced error messages and validation in English
- Better Configuration: More flexible configuration options for different Typebot instances
- Code Quality: Various code improvements and optimizations
This starts the MCP server on STDIO. Claude Desktop (or any MCP client) will connect to it automatically.
