HarmonyOS MCP Server — 一键安装指南

知识库已内置! 无需爬虫、无需外部目录,安装即用。

前置条件

  • Node.js >= 18
  • 本项目目录(含内置的 knowledge/ 知识库)

一键安装

Windows

.\harmonyos-mcp-server\install.ps1

Linux / Mac

bash harmonyos-mcp-server/install.sh

安装脚本自动完成:检查 Node.js → npm install → 构建 → 输出 MCP 配置。


配置到 MCP 客户端

安装完成后,复制脚本输出的 JSON 到对应客户端的 MCP 配置:

Claude Desktop

配置文件:%APPDATA%\Claude\claude_desktop_config.json (Win) 或 ~/Library/Application Support/Claude/claude_desktop_config.json (Mac)

{
  "mcpServers": {
    "harmonyos": {
      "command": "node",
      "args": ["{项目路径}/harmonyos-mcp-server/dist/index.js"]
    }
  }
}

Cursor

配置文件:~/.cursor/mcp.json

{
  "mcpServers": {
    "harmonyos": {
      "command": "node",
      "args": ["{项目路径}/harmonyos-mcp-server/dist/index.js"]
    }
  }
}

Continue.dev (VS Code)

{
  "experimental": {
    "mcpServers": [
      {
        "name": "harmonyos",
        "command": "node",
        "args": ["{项目路径}/harmonyos-mcp-server/dist/index.js"]
      }
    ]
  }
}

⚠️ {项目路径} 必须替换为绝对路径


知识库内容

内置 knowledge/ 目录包含完整华为 HarmonyOS NEXT 开发文档:

分类 文档数
harmonyos-guides 5,338
harmonyos-references 4,424
harmonyos-releases 1,081
总计 10,843

更新知识库

# 增量更新
npx --prefix knowledge-base/scraper tsx knowledge-base/scraper/src/main.ts

# 重新复制到 MCP
robocopy knowledge-base/references harmonyos-mcp-server/knowledge /E /NJH /NJS /NP

# 重启 MCP 客户端

验证

安装后在 Claude Desktop 中测试:

请列出 HarmonyOS 的所有 Kit

应该调用 harmonyos_list_kits 返回 14 个 Kit。

或用 MCP Inspector:

npx @modelcontextprotocol/inspector node harmonyos-mcp-server/dist/index.js

工具一览(10 个)

文档检索

工具 说明
harmonyos_search_docs 全文搜索
harmonyos_get_document 读取文档
harmonyos_list_kits Kit 列表
harmonyos_get_kit_docs Kit 文档
harmonyos_get_api_ref API 查询
harmonyos_search_index 路径搜索

知识图谱

工具 说明
harmonyos_graph_search 图谱搜索
harmonyos_graph_neighbors 邻居查询
harmonyos_graph_path 路径查找
harmonyos_graph_stats 统计概览