harmonyos-guides-mcp 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -4
- package/data/INDEX.md +5514 -0
- package/data/{docs/_crawl_log.txt → index_log.txt} +1 -1
- package/data/synonyms.json +58 -0
- package/dist/data.js +13 -5
- package/dist/search.js +180 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
把鸿蒙官方开发指南(5489 篇)封装成 MCP 检索服务,供 Claude Code / opencode / Cursor / Cline 等客户端在开发时查 API/Kit 用法。**文档(52MB)随包发布,装包即用、零配置。**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
与姊妹项目分工互补:
|
|
6
|
+
|
|
7
|
+
| | 本项目(guides) | best-practices | api-references | ui-design-guides |
|
|
8
|
+
|---|---|---|---|---|
|
|
9
|
+
| 查什么 | **API 用法、调用流程** | **场景最佳实践 + 参考代码** | **接口精确定义**(参数/枚举) | **设计怎么做**(视觉/交互/控件设计规范) |
|
|
10
|
+
| 数据 | 5489 篇指南 | 452 篇 + 186 代码仓库 | 4495 篇 API 参考 | 166 篇设计指南 |
|
|
11
|
+
| 适用 | "AVPlayer 怎么初始化" | "长列表丢帧优化" | "AudioCapturer 方法签名" | "底部页签设计规范" |
|
|
12
|
+
|
|
13
|
+
四者并列:guides 讲 API 用法、best-practices 给场景实践与参考代码、api-references 查精确签名、ui-design-guides 定设计规范。
|
|
6
14
|
|
|
7
15
|
## 提供的工具
|
|
8
16
|
|
|
@@ -62,24 +70,65 @@ npm ls -g harmonyos-guides-mcp # 本地已装版本
|
|
|
62
70
|
```
|
|
63
71
|
或看客户端 MCP 面板里服务器的 `version` 字段。
|
|
64
72
|
|
|
65
|
-
##
|
|
73
|
+
## 四者并列使用
|
|
74
|
+
|
|
75
|
+
### OpenCode 示例
|
|
66
76
|
|
|
67
77
|
```json
|
|
68
78
|
{
|
|
69
79
|
"mcp": {
|
|
70
80
|
"harmonyos-best-practices": {
|
|
71
81
|
"type": "local",
|
|
72
|
-
"command": ["npx", "-y", "harmonyos-best-practices-mcp"]
|
|
82
|
+
"command": ["npx", "-y", "harmonyos-best-practices-mcp"],
|
|
83
|
+
"environment": { "BP_CODE_DIR": "/abs/path/to/best_practices_code" }
|
|
73
84
|
},
|
|
74
85
|
"harmonyos-guides": {
|
|
75
86
|
"type": "local",
|
|
76
87
|
"command": ["npx", "-y", "harmonyos-guides-mcp"]
|
|
88
|
+
},
|
|
89
|
+
"harmonyos-api-references": {
|
|
90
|
+
"type": "local",
|
|
91
|
+
"command": ["npx", "-y", "harmonyos-api-references-mcp"]
|
|
92
|
+
},
|
|
93
|
+
"harmonyos-ui-design-guides": {
|
|
94
|
+
"type": "local",
|
|
95
|
+
"command": ["npx", "-y", "harmonyos-ui-design-guides-mcp"]
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Claude Code 示例
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"mcpServers": {
|
|
106
|
+
"harmonyos-best-practices": {
|
|
107
|
+
"command": "npx",
|
|
108
|
+
"args": ["-y", "harmonyos-best-practices-mcp"],
|
|
109
|
+
"env": { "BP_CODE_DIR": "/abs/path/to/best_practices_code" }
|
|
110
|
+
},
|
|
111
|
+
"harmonyos-guides": {
|
|
112
|
+
"command": "npx",
|
|
113
|
+
"args": ["-y", "harmonyos-guides-mcp"]
|
|
114
|
+
},
|
|
115
|
+
"harmonyos-api-references": {
|
|
116
|
+
"command": "npx",
|
|
117
|
+
"args": ["-y", "harmonyos-api-references-mcp"]
|
|
118
|
+
},
|
|
119
|
+
"harmonyos-ui-design-guides": {
|
|
120
|
+
"command": "npx",
|
|
121
|
+
"args": ["-y", "harmonyos-ui-design-guides-mcp"]
|
|
77
122
|
}
|
|
78
123
|
}
|
|
79
124
|
}
|
|
80
125
|
```
|
|
81
126
|
|
|
82
|
-
|
|
127
|
+
### BP_CODE_DIR 设置
|
|
128
|
+
|
|
129
|
+
> **`BP_CODE_DIR`(仅 best-practices 可选)**:指向本地 `best_practices_code/` 目录(从 GitHub Release 下载 `harmonyos-best-practices-code.tar.gz` 解压得到)。配置后 `get_code_example` 会返回本地仓库路径与入口 `.ets` 文件,AI 可直接读取真实官方示例代码;**不配则只返回 gitcode 远程 URL**。Windows 路径用正斜杠更稳(如 `C:/path/to/best_practices_code`)。其余三个 MCP 是纯文档,无需此变量。
|
|
130
|
+
|
|
131
|
+
搭配各自的 Skill(`harmonyos-best-practices` / `harmonyos-guides` / `harmonyos-api-references` / `harmonyos-ui-design-guides`),AI 可据需求选用:guides 查 API 用法、best-practices 查场景实践与参考代码、api-references 查精确签名、ui-design-guides 查设计规范。
|
|
83
132
|
|
|
84
133
|
## 开发与发布(维护者)
|
|
85
134
|
|