ArkTS Helper
FreeNot checkedProvides documentation search, reading, and AI-powered Q\&A for ArkTS/ArkUI development, enabling AI coding assistants to answer questions and retrieve official
About
Provides documentation search, reading, and AI-powered Q&A for ArkTS/ArkUI development, enabling AI coding assistants to answer questions and retrieve official docs.
README
ArkTS/ArkUI 开发助手 MCP Server,为 AI 编程助手(Claude Code、Cursor、Windsurf 等)提供文档检索和华为官方智能问答能力。
功能概览
| 工具 | 功能 | 说明 |
|---|---|---|
find_docs |
文档搜索 | 关键词搜索 1000+ 篇 ArkTS/ArkUI 官方文档 |
read_doc |
文档阅读 | 根据 objectId 获取完整 Markdown 内容 |
list_doc_topics |
分类浏览 | 列出所有文档主题及数量 |
ask_ai |
AI 问答 | 调用华为官方智能问答,获取整合回答 |
ask_ai_batch |
批量问答 | 并行处理多个问题,大幅节省时间 |
read_more |
读取全文 | 获取被截断的完整回答 |
set_ai_auth |
设置凭证 | 配置登录态 Cookie,突破匿名次数限制 |
快速开始
安装
git clone https://github.com/LongLiveY96/arkts-helper-mcp.git
cd arkts-helper-mcp
npm install
npm run build
配置 AI 助手
Claude Code / Cursor / Windsurf:
{
"mcpServers": {
"arkts-helper": {
"command": "node",
"args": ["/path/to/arkts-helper-mcp/dist/index.js"]
}
}
}
HTTP 模式(可选)
npm run start:http
端点:
GET /health— 健康检查GET /search?q=关键词— 搜索文档GET /doc/:objectId— 获取文档GET /topics— 列出主题
使用示例
配置完成后,AI 助手会自动调用工具:
用户:@State 和 @Prop 有什么区别?
AI:→ find_docs({ query: "State Prop 装饰器" })
→ read_doc({ objectId: "arkts-state" })
@State 是组件私有状态,@Prop 是单向数据传递...
用户:Navigation 怎么实现页面跳转并传参?
AI:→ ask_ai({ query: "Navigation 页面跳转传参" })
Navigation 是路由容器组件,通过 NavPathStack 管理页面栈...
用户:同时告诉我 @State、@Prop、@Link 的用法
AI:→ ask_ai_batch({ queries: ["@State用法", "@Prop用法", "@Link用法"] })
(并行查询,约 60 秒返回全部结果)
环境变量
| 变量名 | 说明 | 默认值 |
|---|---|---|
ARKTS_DOCS_DIR |
文档目录路径 | static/docs |
ARKTS_MCP_PORT |
HTTP 服务端口 | 3456 |
ARKTS_QA_TIMEOUT_MS |
AI 问答超时(毫秒) | 120000 |
ARKTS_MCP_CONFIG_DIR |
Cookie 配置目录 | ~/.config/arkts-mcp |
AI 问答认证(可选)
匿名模式有次数限制。配置登录态 Cookie 可解除限制:
- 登录 developer.huawei.com
- F12 → Network → 使用智能问答提问
- 找到
dialog/submission请求,复制 Cookie - 通过工具设置:
set_ai_auth({ cookie: "你的Cookie" })
Cookie 保存在 ~/.config/arkts-mcp/config.json,不会进入代码仓库。
许可证
MIT
Install ArkTS Helper in Claude Desktop, Claude Code & Cursor
unyly install arkts-helper-mcpInstalls into Claude Desktop, Claude Code, Cursor & VS Code — handles npx, uvx and build-from-source repos for you.
First time? Get the CLI: curl -fsSL https://unyly.org/install | sh
Or configure manually
Run in your terminal:
claude mcp add arkts-helper-mcp -- npx -y github:LongLiveY96/arkts-helperFAQ
Is ArkTS Helper MCP free?
Yes, ArkTS Helper MCP is free — one-click install via Unyly at no cost.
Does ArkTS Helper need an API key?
No, ArkTS Helper runs without API keys or environment variables.
Is ArkTS Helper hosted or self-hosted?
A hosted option is available: Unyly runs the server in the cloud, no local setup required.
How do I install ArkTS Helper in Claude Desktop, Claude Code or Cursor?
Open ArkTS Helper on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.
Related MCPs
Notion
Read and write pages in your workspace
by NotionLinear
Issues, cycles, triage — from Claude
by LinearGoogle Drive
Search and read your Drive files
by Googlemindsdb/mindsdb
Connect and unify data across various platforms and databases with [MindsDB as a single MCP server](https://docs.mindsdb.com/mcp/overview).
by mindsdbCompare ArkTS Helper with
Not sure what to pick?
Find your stack in 60 seconds
Author?
Embed badge for your README
Browse similar
All productivity MCPs
