内容
# 非官方 OpenHarmony/HarmonyOS MCP 服务器
[](https://github.com/megaacheyounes/ohos-mcp-unofficial)
[](https://opensource.org/licenses/MIT)
这是一个非官方的模型上下文协议(MCP)服务器,直接为您的 AI 助手提供 **HarmonyOS & OpenHarmony 文档** 的强大功能。它索引了超过 5,000 个官方文档文件,以便进行即时、高上下文的检索。
---
## 🚀 快速开始:零安装方法(推荐)
使用此服务器最简单的方法是通过 `npx`。无需克隆!
### 1. Claude 桌面版
在您的 `claude_desktop_config.json` 中添加以下内容:
```json
{
"mcpServers": {
"ohos-docs": {
"command": "npx",
"args": ["-y", "github:megaacheyounes/ohos-mcp-unofficial"]
}
}
}
```
### 2. ChatGPT Codex CLI
使用以下命令添加服务器:
```bash
codex mcp add ohos -- npx -y github:megaacheyounes/ohos-mcp-unofficial
```
### 3. OpenCode AI
在 OpenCode 设置或配置中:
- **命令**:`npx`
- **参数**:`-y github:megaacheyounes/ohos-mcp-unofficial`
### 4. Cursor / Windsurf / IDEs
在设置中添加新的 MCP 服务器:
- **类型**:`command`
- **命令**:`npx -y github:megaacheyounes/ohos-mcp-unofficial`
### 5. Gemini CLI
在您的 `.geminirc` 中:
```json
{
"mcpServers": {
"ohos": {
"command": "npx",
"args": ["-y", "github:megaacheyounes/ohos-mcp-unofficial"]
}
}
}
```
---
## 🖼️ 多模态支持
文档已针对具有“视觉”能力的 AI 代理进行了优化。
- **远程图像**:所有图表和截图都直接链接到官方 Gitee 仓库。
- **代理操作**:多模态代理可以遵循这些链接下载和分析视觉架构图、UI 原型和流程图,以提供更准确的解释。
---
## 🌐 了解两种模式
### 1. 标准输入/输出模式(默认)
由本地助手(Claude 桌面版、Cursor 等)使用。助手将服务器作为后台进程启动。
### 2. HTTP 模式
用于远程访问或 Web 集成。
```bash
# 启动服务器
npx -y github:megaacheyounes/ohos-mcp-unofficial --http --port 3456
```
- **健康检查**:`http://localhost:3456/health`
- **工具调用**:POST 到 `http://localhost:3456/call`
---
## 🧰 可用工具
- `find_docs`:按关键词搜索文档(例如,“导航”、“画布”)。
- `read_doc`:检索特定文档的完整 Markdown 内容。
- `list_doc_topics`:浏览文档层次结构。
---
## 🌟 鸣谢
灵感来自 [arkts-helper](https://github.com/LongLiveY96/arkts-helper)。此版本专门针对使用 OpenHarmony 6.1(API 23)开源文档的中文社区进行了优化。
## ⚖️ 免责声明
本项目为非官方社区项目,与华为技术有限公司或 OpenHarmony 项目无关、未被维护或认可。
本项目的部分内容由 **AI** 生成或协助。
使用此工具和它检索的文档风险自负。请始终与[官方文档](https://developer.huawei.com)核实关键信息。
## 📄 许可证
MIT © [megaacheyounes](https://github.com/megaacheyounes)