skills.rest
YrracOwl
YrracOwlCOMMUNITY
Explore all skills by this author →
GitHub

hmos-doc-research

Retrieves authoritative HarmonyOS API signatures and documentation before writing ArkTS code.

Updated Sep 3, 2026
Search Tags:#sdk#documentation search#arkui#api lookup#harmonyos#arkts#developer.huawei.com
One-click install
npx skills add https://github.com/YrracOwl/dsh-hmos-sidebar --skill hmos-doc-research-yrracowl
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: hmos-doc-research
Source: https://github.com/YrracOwl/dsh-hmos-sidebar/tree/main/packages/dsh-hmos-sidebar/presets/native-harmonyos/skills/hmos-doc-research
Command: npx skills add https://github.com/YrracOwl/dsh-hmos-sidebar --skill hmos-doc-research-yrracowl

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? HarmonyOS developers often write code from memory and end up using outdated, deprecated, or nonexistent APIs, causing build failures and runtime errors. This Skill enforces a lookup-first workflow that grounds every API usage in official SDK declarations and documentation. ## Core Features & Use Cases - Unified API Lookup: Uses dcli__api_lookup to return exact SDK .d.ts signatures with file and line references, plus matching local documentation entries. - Offline Documentation Search: Queries the local DevEco documentation index via dcli__docs_search and reads full articles with dcli__docs_read. - Official Web Fallback: Restricts web searches to developer.huawei.com and docs.openharmony.cn for authoritative confirmation. - Use Case: Before implementing an ArkUI component with state management, look up the exact @ComponentV2 decorator signature and confirm the target compileSdkVersion supports it, avoiding V1/V2 syntax mismatches. ## Quick Start Look up the official HarmonyOS API signature and documentation for the TextInput component before writing any ArkTS code.

Frequently Asked Questions about hmos-doc-research

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I look up HarmonyOS API signatures before writing ArkTS code?▼

Call dcli__api_lookup with the API name, such as a component, @ohos interface, decorator, or Kit. It returns the exact SDK .d.ts signature with file and line references plus matching local documentation entries.

What is the best way to search HarmonyOS official documentation offline?▼

Use dcli__docs_search to query the local DevEco documentation index by keyword, then pass the returned documentId to dcli__docs_read to read the full article. This covers development guides, API references, and FAQs without internet access.

Does HarmonyOS API lookup work across different SDK versions?▼

Yes, signatures come from the locally installed SDK matching your compileSdkVersion, so results reflect the exact version you target. Always confirm the API exists in your target SDK before using it, since older online examples may be incompatible.

Why do HarmonyOS code examples from blogs fail to compile?▼

Many online examples use pre-API 9 syntax or ArkUI state management V1 patterns incompatible with current SDKs. Verify signatures against your installed SDK declarations and official documentation instead of trusting third-party blogs.

When should I use web search instead of local HarmonyOS documentation?▼

Use web search only after SDK declaration lookup and local documentation search, restricting queries to developer.huawei.com or docs.openharmony.cn. It serves as a fallback for cross-confirming signatures, permissions, and version-specific behavior.

Related Skills

Explore More Software Engineering Skills→
linhaylinhay
284

harmony-next

Automate HarmonyOS NEXT development tasks with offline API references and diagnostics.

Community
Advanced
openJiuwen-aiopenJiuwen-ai
7.1k

harmonyos-dev-suite

Routes HarmonyOS development tasks across ArkTS, ArkUI, build, debug, testing, and device workflows.

Official
Advanced
openharmonyinsightopenharmonyinsight
31

arkts-static-spec

Answer ArkTS static-semantics and TypeScript migration questions from official documentation.

Official
Intermediate
syncfusionsyncfusion

syncfusion-javascript-file-manager

Manage web-based file systems with the Syncfusion FileManager component.

Official
Advanced