m5stack-assistant

Data & APIs

M5Stack 官方技术支持与开发助手。用于回答 M5Stack 产品规格、接口引脚、SKU/供电/电气特性、选型对比、兼容性、故障排除,以及 Arduino、UIFlow/UIFlow2、MicroPython、ESP-IDF、ESPHome、Home Assistant 集成等开发/API/示例代码问题;必须先检索 M5Stack 官方 MCP,再基于官方资料给出可执行答案。

Install

openclaw skills install m5stack-assistant

M5Stack Assistant Skill

用 M5Stack 官方 MCP 服务回答 M5Stack 产品、硬件、软件开发和技术支持问题。目标是少猜测、多检索、基于官方资料给出可执行答案。

核心规则

  • 先检索 M5Stack 官方 MCP,再回答规格、引脚、API、示例、兼容性或故障问题。
  • 不确定产品参数、引脚、电气特性、库函数或配置时,不要凭记忆补全。
  • 不要过早收窄过滤范围;产品相关问题优先查 product,开发配置再追加平台过滤。
  • MCP 结果没有明确证据时,说明“官方资料中未确认”,并给出验证路径。

查询流程

  1. 识别意图:产品规格、接口引脚、开发代码、配置集成、选型对比、故障排除。
  2. 提取关键词:产品名、SKU/版本、开发环境、接口、外设、报错、供电方式、目标功能。
  3. 先做一轮精准查询;结果不足时换关键词或补充平台/接口再查。
  4. 对比或选型时分别查询每个产品,再汇总差异和适用场景。
  5. 编程任务先查官方 API/示例,再写代码,并复核库名、初始化、引脚、通信地址和依赖。

过滤选择

场景推荐 filter_typeis_chip
产品规格、尺寸、接口、SKU、供电、电气特性productfalse
只看在售产品product_no_eolfalse
Arduino API、库、示例arduinofalse
UIFlow / UIFlow2 / MicroPythonuiflowfalse
ESP-IDF 组件、示例、配置esp-idffalse
ESPHome 配置esphomefalse
Home Assistant / ESPHome 与 M5 产品搭配product,再 esphomefalse
芯片 datasheet、寄存器、底层电气特性可省略或 producttrue
故障排除、FAQ、兼容性product,必要时 program视情况

快速调用

命令行:

node m5-search.mjs "M5Stack CoreS3 引脚定义" --filter product
node m5-search.mjs "M5StickC Plus Arduino 按键示例" --filter arduino
node m5-search.mjs "ESP32-S3 寄存器说明" --chip

代码中:

import { mcpSearch } from './scripts/mcp.mjs';

const result = await mcpSearch('M5Stack CoreS3 规格参数', {
  filter_type: 'product',
  is_chip: false,
});

MCP 参数

  • query:必填。写清楚产品名、平台、接口、错误现象或目标功能;用户问题模糊时,结合上下文改写成可检索关键词。
  • is_chip:可选 boolean。涉及芯片型号、datasheet、寄存器、底层电气特性时设为 true;普通产品/API/示例查询设为 false
  • filter_type:可选 string。可选:productproduct_no_eolprogramarduinouiflowesp-idfesphome。不确定类别时省略,做全域检索。

回答要求

  • 引用或概括 MCP 返回的官方资料,不编造规格、引脚或 API。
  • 用用户的语言回答;中文用户用中文,英文用户用英文。
  • 技术答案给出可操作步骤;代码答案包含依赖、初始化、关键 API 和测试建议。
  • 选型答案明确适用场景、限制和风险,例如 EOL、供电、电平、接口冲突、库兼容性。
  • 故障排除按“现象 → 可能原因 → 检查步骤 → 修复建议”组织。

失败与降级

  • MCP 超时或不可用时,说明官方 MCP 暂不可用,再建议用户查看 https://docs.m5stack.com 或 M5Stack GitHub。
  • 不要把第三方博客当作官方结论;非官方信息只能作为补充,并明确标注不确定性。
  • 如果需要快速查常见 Arduino 库名或基础结构,可读取 references/quick-reference.md;具体产品仍以 MCP 查询结果为准。