HarmonyOS MCP Server

为 HarmonyOS 系统软件开发和商用提供智能文档检索的 MCP Server。

知识库已内置 — 无需爬虫、无需外部目录，安装即用。
覆盖 10,843 篇华为官方 HarmonyOS NEXT 开发文档 + 5,295 节点知识图谱。

工具列表（11 个）

工具	用途
harmonyos_search_docs	全文搜索知识库，返回匹配文档及摘要
harmonyos_get_document	按路径获取文档完整内容
harmonyos_list_kits	列出所有 Kit 及文档数量
harmonyos_get_kit_docs	获取某个 Kit 下的文档路径列表
harmonyos_get_api_ref	查找 @ohos.* API 模块文档
harmonyos_search_index	正则搜索文档路径索引
harmonyos_graph_search	知识图谱节点搜索
harmonyos_graph_neighbors	查询节点的邻居节点和关系
harmonyos_graph_path	查找两个节点之间的关联路径
harmonyos_graph_stats	知识图谱统计信息
harmonyos_setup	下载/管理本地知识库

提示词模板（22 个）

#	Prompt	场景
1	harmonyos_dev	HarmonyOS 通用开发
2	harmonyos_arkts	ArkTS 语言开发
3	harmonyos_arkui	ArkUI 组件开发
4	harmonyos_api	API 参考查询
5	harmonyos_ability	Ability Kit 应用框架
6	harmonyos_data	ArkData 数据管理
7	harmonyos_media	媒体开发
8	harmonyos_network	网络通信
9	harmonyos_security	安全与权限
10	harmonyos_performance	性能优化
11	harmonyos_distributed	分布式与跨设备
12	harmonyos_ndk	NDK/C++ 开发
13	harmonyos_debug	调试与测试
14	harmonyos_publish	发布与上架
15	harmonyos_file	文件管理与存储
16	harmonyos_notification	通知与推送
17	harmonyos_background	后台任务
18	harmonyos_i18n	国际化与本地化
19	harmonyos_accessibility	无障碍
20	harmonyos_graphics	图形与绘制
21	harmonyos_error	错误检查与诊断
22	harmonyos_convert	代码转换到 ArkTS（Java/Kotlin/JS/TS/Swift/C++）

快速开始

一键安装

# Windows
.\harmonyos-mcp-server\install.ps1

# Linux / Mac
bash harmonyos-mcp-server/install.sh

手动安装

npm --prefix harmonyos-mcp-server install
npm --prefix harmonyos-mcp-server run build

配置 MCP 客户端

在 Claude Desktop 或其他 MCP 客户端的配置中添加：

{
  "mcpServers": {
    "harmonyos": {
      "command": "node",
      "args": [
        "D:/code/hm_studio_vscode/harmonyos-mcp-server/dist/index.js"
      ]
    }
  }
}

开发调试

# 开发模式
npx tsx harmonyos-mcp-server/src/index.ts

# 使用 MCP Inspector 调试
npx @modelcontextprotocol/inspector node harmonyos-mcp-server/dist/index.js

使用示例

搜索 API 用法

搜索 "@ohos.app.ability.Ability"
→ harmonyos_search_docs 找到 6 篇文档
→ harmonyos_get_document 读取完整 API 参考

查找组件开发指南

搜索 "Canvas 绘制"
→ harmonyos_search_docs 返回 31 篇匹配文档
→ 按 Kit 过滤: harmonyos_search_docs --kit ArkUI

浏览 Kit 能力

列出所有 Kit
→ harmonyos_list_kits 返回 14 个 Kit 分类
→ harmonyos_get_kit_docs --kit MediaKit 返回 200+ 篇媒体文档

查找错误码

搜索 "错误码 16000001"
→ harmonyos_search_docs 定位到对应错误码文档
→ harmonyos_get_document 获取完整说明和解决方案

项目结构

harmonyos-mcp-server/
  src/
    index.ts              # 入口 + McpServer 初始化
    prompts.ts            # 21 个场景化 Prompt 模板
    lib/
      knowledge.ts        # 知识库访问层
      types.ts            # 共享类型
    tools/
      search.ts           # harmonyos_search_docs
      document.ts         # harmonyos_get_document
      kits.ts             # list_kits + get_kit_docs
      api-ref.ts          # get_api_ref + search_index
      graph.ts            # graph_search / neighbors / path / stats
      setup.ts            # harmonyos_setup
  dist/                   # 编译产物
  knowledge/              # 内置知识库（10,843 篇文档）
  package.json
  tsconfig.json

知识库覆盖

分类	文档数
harmonyos-guides（开发指南）	5,338
harmonyos-references（API 参考）	4,424
harmonyos-releases（版本说明）	1,081
总计	10,843

覆盖 14 个 Kit 类别，包括 ArkUI、ArkTS、AbilityKit、MediaKit、ArkGraphics、ConnectivityKit、Security 等。

技术栈

• 运行时: Node.js 18+
• MCP SDK: @modelcontextprotocol/sdk 1.6+
• 输入验证: Zod 3.23+
• 传输: stdio（本地 spawn）
• 语言: TypeScript 5.7+