From HarmonyOS Skills
Search HarmonyOS API reference Markdown files in api-references to find modules, API signatures, types, permissions, system capabilities, examples, and feature-level implementation guidance. Use when looking up HarmonyOS/OpenHarmony/HMS APIs, ArkTS APIs, Kit documentation, @ohos or @hms modules, system capabilities, permissions, or when adapting code to HarmonyOS. The api-references file names include Kit names, so always search file names first before content.
How this skill is triggered — by the user, by Claude, or both
Slash command
/harmony-skills:harmonyos-sdk-api-lookupThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
在本 skill 目录下的 `api-references/` 中搜索 HarmonyOS API 参考 Markdown 文档,支持两种查询模式:
api-references/AI-Agent Framework Kit(智能体框架服务)-ArkTS API错误码.mdapi-references/AI-Agent Framework Kit(智能体框架服务)-ArkTS组件-FunctionComponent(功能组件).mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-头文件-hiai_aipp_param.h.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-头文件-hiai_helper.h.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-头文件-hiai_options.h.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-头文件-hiai_single_op.h.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-头文件-hiai_tensor.h.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-结构体-HiAISingleOpDescriptor_ConvolutionParam.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-结构体-HiAI_SingleOpExecutorConvolutionParam.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-头文件和结构体-结构体-HiAI_SingleOpExecutorFusedConvolutionActivationParam.mdapi-references/AI-CANN Kit(CANN异构计算框架服务)-C API-模块-CANN.mdapi-references/AI-Core Speech Kit(基础语音服务)-ArkTS API-speechRecognizer(语音识别).mdapi-references/AI-Core Speech Kit(基础语音服务)-ArkTS API-textToSpeech(文本转语音).mdapi-references/AI-Core Speech Kit(基础语音服务)-ArkTS API错误码.mdapi-references/AI-Core Vision Kit(基础视觉服务)-ArkTS API-VisionBase(Core Vision Kit基类).mdapi-references/AI-Core Vision Kit(基础视觉服务)-ArkTS API-faceComparator(人脸比对).mdapi-references/AI-Core Vision Kit(基础视觉服务)-ArkTS API-faceDetector(人脸检测).mdapi-references/AI-Core Vision Kit(基础视觉服务)-ArkTS API-objectDetection(多目标识别).mdapi-references/AI-Core Vision Kit(基础视觉服务)-ArkTS API-skeletonDetection(骨骼点检测).mdapi-references/AI-Core Vision Kit(基础视觉服务)-ArkTS API-subjectSegmentation(主体分割).md在本 skill 目录下的 api-references/ 中搜索 HarmonyOS API 参考 Markdown 文档,支持两种查询模式:
api-references/.md 文件媒体-Camera Kit(相机服务)-ArkTS [email protected] (相机管理)-Interface (CameraManager).md媒体-Audio Kit(音频服务)-ArkTS [email protected] (音频管理)-Functions.md系统-网络-Connectivity Kit(短距通信服务)-ArkTS [email protected] (WLAN).mdapi-references/
├── ... ArkTS API / C API / 错误码 / 组件 / 指南页面
始终先搜索文件名,再读取候选 Markdown;只在候选过多或文件名无法定位时做全文搜索。
根据用户问题提取 2 到 5 类关键词:
| 关键词类型 | 示例 |
|---|---|
| Kit 名称 | Camera Kit, Audio Kit, Connectivity Kit, Ability Kit |
| 模块名 | @ohos.multimedia.camera, @ohos.net.http, @hms.scan |
| API / 类型名 | CameraManager, createCameraInput, HttpRequest, PhotoOutput |
| 中文功能词 | 相机, 拍照, 网络, 定位, 剪贴板, 权限 |
| API 类型 | ArkTS API, C API, Interface, Functions, Enums, 错误码 |
列出文件,再对文件名做二次过滤:
文件名里已经包含 Kit 名称,所以不需要读取单独的 Kit 索引。命中多个文件时,优先读取最精确的页面:
Interface (Xxx).md / Class (Xxx).md / Functions.md@ohos.xxx (...).mdEnums.md / Types.md / Interfaces (其他).md读取候选文档前,先检查文件大小和行数,避免把超大 Markdown 一次性读入上下文:
Get-Item "harmonyos-sdk-api-lookup/api-references/目标文件.md" | Select-Object Length,FullName
(Get-Content "harmonyos-sdk-api-lookup/api-references/目标文件.md" | Measure-Object -Line).Lines
按以下规则读取:
| 功能领域 | 优先文件名关键词 |
|---|---|
| 网络/HTTP/WebSocket | 网络, Connectivity Kit, Network Kit, @ohos.net, http, webSocket |
| 文件/存储 | 文件, Core File Kit, ArkData, file, fs, picker |
| 相机/拍照 | Camera Kit, 相机, @ohos.multimedia.camera |
| 音频/音效 | Audio Kit, 音频, @ohos.multimedia.audio |
| 视频/播放/录制 | Media Kit, 媒体, AVPlayer, AVRecorder |
| 图片处理 | Image Kit, 图片, image |
| 蓝牙/WiFi/NFC | Connectivity Kit, 蓝牙, WLAN, NFC, wifi, bluetooth |
| 定位/GPS | Location Kit, 位置, 定位, geoLocationManager |
| 传感器 | Sensor Service Kit, 传感器, sensor |
| 通知 | Notification Kit, 通知, notification |
| 加密/安全 | Crypto Architecture Kit, Universal Keystore Kit, 加密, 密钥 |
| 设备信息/电池/振动 | Basic Services Kit, deviceInfo, batteryInfo, vibrator |
| 剪贴板 | Basic Services Kit, pasteboard, 剪贴板 |
| UI 组件 | ArkUI, 组件, 组件名 |
| Web/WebView | ArkWeb, Web, webview, @ohos.web |
| 后台任务 | Background Tasks Kit, 后台任务, backgroundTaskManager |
| 应用生命周期 | Ability Kit, Ability, Want, UIAbility |
| 扫码/二维码 | Scan Kit, 扫码, 二维码, @hms.scan |
| 地图 | Map Kit, 地图, @hms.map |
| 推送 | Push Kit, 推送, @hms.push |
| 支付/内购 | IAP Kit, Payment Kit, 支付, 内购 |
| 语音识别/合成 | Speech Kit, Core Speech Kit, 语音 |
| OCR/图像识别 | Vision Kit, Core Vision Kit, OCR, 图像识别 |
关键类型定义: (列出代码中用到的 interface / enum 定义摘要)
注意事项:
分析 API 关系的方法:
TypeX,方法 B 接收 TypeX 作为参数,则 A 的输出可能是 B 的输入XxxConfig / XxxOptions 接口,先构造配置再调用create/open + start/execute + stop/close/release 时,需要完整管理资源on(event, callback) / off(event) 时,注册后需在适当时机取消api-references/ Markdown 中实际存在的定义权限信息仅在文档中出现明确的权限标注时才记录:
有效权限标注格式(必须包含以下关键词):
**需要权限:** ohos.permission.xxx**权限:** ohos.permission.xxxrequired_permission: ohos.permission.xxx以下内容 ≠ 权限要求(常见误判):
TYPE_FLOAT)或窗口模式无权限标注时的处理:
required_permission 必须返回 null返回权限信息时必须标注来源:
需要权限: ohos.permission.xxx [来源: {文件名}:{行号}]需要权限: ohos.permission.INTERNET [来源: @ohos.net.http.md:52]Creates, edits, and optimizes skills for Claude Code, including drafting, evaluating with test prompts, iterating on performance, and improving skill descriptions for better triggering accuracy.
npx claudepluginhub harmonyos-ai/harmony-skills --plugin harmony-skills