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

hamibot-mcp-server

Hamibot MCP Server 是一个基于MCP协议的服务器实现,用于管理和控制Hamibot设备及自动化脚本,支持设备管理、脚本运行和代码执行等功能。

article

README

🚀 🤖 鹤鼻兽机器人 MCP 服务器

鹤鼻兽机器人 MCP 服务器是基于模型上下文协议 (MCP) 的服务器实现,可与鹤鼻兽机器人 API 交互。它提供了一系列工具,用于管理和控制鹤鼻兽机器人设备及脚本,极大提升了使用的便捷性和效率。

🚀 快速开始

鹤鼻兽机器人 MCP 服务器能让你轻松管理和控制鹤鼻兽机器人设备及脚本。下面为你介绍使用前的准备工作。

✨ 主要特性

  • 🔧 设备管理:可列出所有连接的设备,方便你掌握设备状态。
  • 📜 脚本管理:能查看和运行自动化脚本,提高工作效率。
  • 💻 代码执行:支持在指定设备上执行自定义 JavaScript 代码,满足个性化需求。
  • 📦 支持变量传递:可以向脚本传递自定义参数,增强脚本的灵活性。

⚙️ 配置

获取访问令牌

  1. 访问 https://hamibot.com/account/tokens
  2. 点击“生成”按钮获取访问令牌。

在 Trae 中使用

详细步骤可参考 Trae 文档:https://docs.trae.ai/ide/model-context-protocol?_lang=zh

  1. 按下按键 F1
  2. 输入 打开 MCP 配置 JSON,然后点击进入。
  3. mcp.json 中添加以下内容:
{
  "mcpServers": {
    "hamibot": {
      "command": "npx",
      "args": ["-y", "@hmbt/hamibot-mcp-server"],
      "env": {
        "HAMIBOT_PERSONAL_ACCESS_TOKEN": "你的访问令牌"
      }
    }
  }
}

⚠️ 重要提示

其他客户端请参考相应的文档进行配置。

🛠️ 可用工具

list-devices

列出所有已连接的设备,方便你了解设备连接情况。

list-scripts

列出所有可用的自动化脚本,让你快速找到所需脚本。

run-script

在指定设备上运行脚本。 参数说明: | 属性 | 详情 | |------|------| | scriptId | 24 位十六进制字符串,表示要运行的脚本 ID | | devices | 设备列表,包含设备 ID 和可选的设备名称 | | vars | (可选) 传递给脚本的变量 |

execute

在指定设备上执行自定义 JavaScript 代码。 参数说明: | 属性 | 详情 | |------|------| | code | JavaScript 鹤鼻兽机器人代码 | | devices | 设备列表,包含设备 ID 和可选的设备名称 | | vars | (可选) 传递给代码的变量 |

💻 使用示例

基础用法

以下是一些常见的使用示例:

  • 获取设备列表
  • 获取脚本列表
  • 在 "设备名" 上运行脚本 "脚本名",设备名和脚本名加引号会更明确,例如 在 "初号机" 上运行脚本 "演示脚本"

运行脚本 运行脚本

  • 在所有 tag1 标签的设备上运行 "演示脚本"
  • 在初号机上运行这个脚本文件

运行脚本文件

📚 详细文档

开发

# 构建项目
npm run build

# 启动服务器
npm start

# 开发模式(监视文件变化)
npm run watch
help

运行方式说明

cloud

托管运行

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

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

本地运行 / 其它方式

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

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