arkts-docs-mcp

English | 中文

English

MCP server for HarmonyOS ArkTS documentation search. Uses Augment's context engine for semantic search.

Installation

npm install -g arkts-docs-mcp

Or use directly with npx:

npx arkts-docs-mcp --base-url <URL> --token <TOKEN>

Configuration

MCP Settings

Add to your MCP configuration (e.g., Claude Desktop claude_desktop_config.json):

{
  "mcpServers": {
    "arkts-docs": {
      "command": "npx",
      "args": [
        "arkts-docs-mcp",
        "--base-url", "YOUR_BASE_URL",
        "--token", "YOUR_TOKEN"
      ]
    }
  }
}

Command Line Arguments

| Argument | Required | Description | |----------|----------|-------------| | --base-url | Yes | API base URL for the Augment context engine | | --token | Yes | Authentication token | | --enable-log | No | Enable logging |

Tools

search_context

Search HarmonyOS ArkTS documentation using semantic search.

Parameters:

• query (required): Search keywords or natural language query

Example queries:

• "State Prop 装饰器" - State management decorators
• "Navigation 路由 页面跳转" - Navigation and routing
• "List 列表组件" - List component usage
• "animateTo 属性动画" - Animation

Documentation Coverage

Includes 1000+ official HarmonyOS documents:

• ArkTS language syntax and constraints
• ArkUI components (Button, Text, List, Grid, etc.)
• State management (@State, @Prop, @Link, @Observed, etc.)
• Animation and transitions
• Navigation and routing
• System APIs and capabilities

License

MIT

中文

HarmonyOS ArkTS 官方文档搜索 MCP 服务器。使用 Augment 上下文引擎进行语义搜索。

安装

npm install -g arkts-docs-mcp

或直接使用 npx：

npx arkts-docs-mcp --base-url <URL> --token <TOKEN>

配置

MCP 设置

添加到你的 MCP 配置文件（例如 Claude Desktop 的 claude_desktop_config.json）：

{
  "mcpServers": {
    "arkts-docs": {
      "command": "npx",
      "args": [
        "arkts-docs-mcp",
        "--base-url", "YOUR_BASE_URL",
        "--token", "YOUR_TOKEN"
      ]
    }
  }
}

命令行参数

| 参数 | 必填 | 描述 | |------|------|------| | --base-url | 是 | Augment 上下文引擎的 API 地址 | | --token | 是 | 认证令牌 | | --enable-log | 否 | 启用日志 |

工具

search_context

搜索 HarmonyOS ArkTS 官方开发文档。

参数：

• query（必填）：搜索关键词或自然语言查询

搜索示例：

• "State Prop 装饰器" - 状态管理装饰器
• "Navigation 路由 页面跳转" - 导航和路由
• "List 列表组件" - List 组件用法
• "animateTo 属性动画" - 动画

文档覆盖范围

包含 1000+ 份官方 HarmonyOS 文档：

• ArkTS 语言语法和约束
• ArkUI 组件（Button、Text、List、Grid 等）
• 状态管理（@State、@Prop、@Link、@Observed 等）
• 动画和转场效果
• 导航和路由
• 系统 API 和能力

许可证

MIT