arkts-docs-ace-mcp

# Tool List ArkTS/ArkUI Official Documentation Search MCP Server, providing semantic search capabilities based on the Augment context engine. ## Overview | Tool | Function | Description | |------|------|------| | `search_context` | Semantic Search | Search 1000+ official documents based on Augment engine | | `read_document` | Document Reading | Read complete Markdown content by file name and category | | `list_topics` | Category Browsing | List document lists for development guides and API references | ## Quick Start ### Installation ```bash npm install -g arkts-docs-ace-mcp ``` ### Configure AI Assistant Add to MCP configuration file (Claude Desktop / Cursor / Windsurf, etc.): ```json { "mcpServers": { "arkts-docs-ace": { "command": "npx", "args": [ "arkts-docs-ace-mcp", "--base-url", "YOUR_BASE_URL", "--token", "YOUR_TOKEN" ] } } } ``` ### Command Line Parameters | Parameter | Required | Description | |------|------|------| | `--base-url` | Yes | Augment context engine API address | | `--token` | Yes | Authentication token | | `--enable-log` | No | Enable log output | ## Tool Description ### search_context Search HarmonyOS ArkTS official documentation and return semantically matched document content. **Parameters:** - `query` (Required): Search keyword, supporting Chinese, English, and natural language - `limit` (Optional): Return result count, default 10, maximum 50 **Example:** ``` search_context({ query: "State Prop decorator" }) search_context({ query: "Navigation routing page jump" }) search_context({ query: "List component", limit: 5 }) ``` ### read_document Read the complete content of a document. Usually used when the summary returned by `search_context` is not detailed enough. **Parameters:** - `filename` (Required): Document file name (without `.md` suffix), extracted from the Path of search results - `category` (Optional): `guides` (development guide) or `references` (API reference), default `guides` **Example:** ``` read_document({ filename: "arkts-state-management-best-practices", category: "guides" }) read_document({ filename: "arkts-apis-audio", category: "references" }) ``` ### list_topics List document topic categories and document lists. **Parameters:** - `category` (Optional): `guides` / `references` / `all`, default `all` **Example:** ``` list_topics({}) list_topics({ category: "guides" }) ``` ## Usage Example ``` User: What's the difference between @State and @Prop? AI: → search_context({ query: "State Prop decorator" }) → read_document({ filename: "arkts-state", category: "guides" }) @State is component private state, @Prop is one-way data transfer... ``` ## Document Coverage Includes 1000+ official HarmonyOS documents: - ArkTS syntax features and language constraints - ArkUI components (Button, Text, List, Grid, etc.) - State management (@State, @Prop, @Link, @Observed, etc.) - Animation and transition effects - Navigation and routing - System API and capabilities ## License MIT