Hamibot MCP Server

🚀 Hamibot Robot MCP Server

The Hamibot Robot MCP Server is a server implementation based on the Model Context Protocol (MCP) for interacting with the Hamibot Robot API. It provides a set of tools to manage and control Hamibot robot devices and scripts.

✨ Features

• Device Management: List all connected devices.
• Script Management: View and run automation scripts.
• Code Execution: Execute custom JavaScript code on specified devices.
• Variable Passing Support: Pass custom parameters to scripts.

⚙️ Configuration

Obtain an Access Token

1. Visit https://hamibot.com/account/tokens.
2. Click "Generate".

Usage in Trae

Refer to the Trae documentation for detailed steps: https://docs.trae.ai/ide/model-context-protocol?_lang=zh

1. Press the F1 key.
2. Type Open MCP Configuration JSON and click to enter.
3. Add the following to mcp.json:

{
  "mcpServers": {
    "hamibot": {
      "command": "npx",
      "args": ["-y", "@hmbt/hamibot-mcp-server"],
      "env": {
        "HAMIBOT_PERSONAL_ACCESS_TOKEN": "Your access token"
      }
    }
  }
}

For other clients, refer to the corresponding documentation.

🛠️ Available Tools

list-devices

List all connected devices.

list-scripts

List all available automation scripts.

run-script

Run a script on specified devices.

Parameters:

• scriptId: A 24-character hexadecimal string representing the ID of the script to run.
• devices: A list of devices, including device IDs and optional device names.
• vars: (Optional) Variables to pass to the script.

execute

Execute custom JavaScript code on specified devices.

Parameters:

• code: Hamibot robot JavaScript code.
• devices: A list of devices, including device IDs and optional device names.
• vars: (Optional) Variables to pass to the code.

📝 Examples

• Get the device list
• Get the script list
• Run the script "Script Name" on the device "Device Name". Using quotes for the device name and script name makes it clearer. For example, Run the script "Demo Script" on the device "Unit-01".

• Run the "Demo Script" on all devices tagged with "tag1"
• Run this script file on the device "Unit-01"

💻 Development

# Build the project
npm run build

# Start the server
npm start

# Development mode (watch file changes)
npm run watch