Skip to main content
Glama
ArkUIBuilder MCP
by aea91

ArkUIBuilder MCP

MCP server that gives AI assistants (Claude Code, Claude Desktop, Cursor, …) the ArkUIBuilder catalog of ready-made HarmonyOS ArkUI components.

Instead of writing UI components from scratch, the assistant finds a tested one, has this server copy it into the project, and writes only the call:

You:    Build a fitness page with a step ring and a dark-mode toggle, using ArkUIBuilder widgets.
Claude: search_widgets("progress ring")  → ProgressRingFb({ value: this.value })
        search_widgets("toggle")         → SwitchFb({ on: this.on })
        add_widget(ProgressRingFb, …/pages/Fitness.ets)   ← file + import written by the server
        add_widget(SwitchFb, …/pages/Fitness.ets)
        …writes only the page: @State value, @State on, and the two calls in build()

Because the component code is copied by the server rather than typed by the model, the assistant spends tokens only on the page itself. For example, ColorStudioFb's signature is ~70 tokens; its source is ~1,400.

Tools

Tool

What it does

search_widgets

Search by words, platform (Mobile, Wearable, PC (2in1), My Widgets) and category. No arguments gives an overview. Each result shows the call and required parameters.

get_widget

One widget's details; include_code: true adds its source (only needed to adapt it).

add_widget

Writes <module>/src/main/ets/components/<Name>.ets, adds import { Name } from '…' to target_file, returns the call. Never overwrites a different existing file unless overwrite: true. Reports $r() / $rawfile() resources the module lacks.

It also lists My Widgets saved with the ArkUIBuilder IDE plugin (found automatically in the IDE config folders; set ARKUIBUILDER_MY_WIDGETS to point at a my-widgets.json elsewhere).

Page templates

Complete pages built from catalog widgets. add_template writes the page, copies its widgets into components/ with their imports, and adds the route to main_pages.json; the page compiles as-is, so the assistant only changes texts and data.

Tool

What it does

search_templates

Lists the templates; filter by words or platform.

add_template

Writes the page to target_file (struct named after the file), adds its widgets, registers the route. Never replaces an existing page unless overwrite: true.

Template

Platform

Widgets

fitness-today

Mobile

segmented control, activity rings, steps, water, sleep

shop-home

Mobile

bottom tab bar, search, category chips, promo, product, cart, coupon, order tracking

wallet-home

Mobile

wallet card, budget donut, transactions, stock

profile-settings

Mobile

profile card, switch row, settings list, theme toggle

sign-in

Mobile

login, sign-up form, password strength

now-playing

Mobile

music card, waveform, equalizer, volume

weather-today

Mobile

weather card, hourly, sunrise arc, radar

watch-health

Wearable

heart rate, steps, rings, SpO2, sleep (vertical swipe)

watch-workout

Wearable

workout, heart rate, stopwatch, music

watch-home

Wearable

digital face, weather, calendar, reminders, smart home

desktop-workspace

PC (2in1)

dashboard, kanban, month calendar, inbox (top tabs)

You:    Make a watch app for heart rate and sleep.
Claude: search_templates("watch health")                 → watch-health
        add_template(watch-health, …/pages/Index.ets)     ← page + 5 widgets + route written by the server

Sample projects

For HarmonyOS APIs (sensors, heart rate, digital crown, notifications, maps, Bluetooth, NFC, storage, …) the server also searches the 550+ open source watch projects of Explore-In-HMOS, so the assistant starts from working code instead of recalling APIs from memory.

Tool

What it does

search_samples

Search by words, kind (how-to, app, lite, library, companion), kit (e.g. SensorServiceKit) and domain. No arguments gives an overview.

get_sample

A project's outline: SDK, requested permissions, and its source files with size and the kits each file imports. files: [...] reads specific files; include_code: true reads the files that use the distinctive kits, within max_chars.

You:    Show the live heart rate on the watch.
Claude: search_samples("heart rate")                      → how-to-get-heart-rate-with-sensorkit
        get_sample(…)                                     → permissions + files; SendToPhone.ets uses SensorServiceKit
        get_sample(…, files: ["SendToPhone.ets"])         → only that file's code

The index ships with the package (data/samples.json); source files are fetched from GitHub when asked for. Without a token GitHub allows 60 file-list requests an hour; set GITHUB_TOKEN in the server's env if you hit that. Lite Wearable projects are JavaScript and do not run on Smart Wearable (ArkTS) devices; results say so.

Related MCP server: UI HUB MCP Server

Setup

Requires Node.js 18+.

Claude Code

claude mcp add arkuibuilder -- npx -y arkuibuilder-mcp

Claude Desktop (claude_desktop_config.json), Cursor (.cursor/mcp.json) and other MCP clients:

{
  "mcpServers": {
    "arkuibuilder": { "command": "npx", "args": ["-y", "arkuibuilder-mcp"] }
  }
}

From a local checkout, use node /path/to/arkuibuilder-mcp/dist/index.js as the command instead.

Development

npm install
npm test               # builds, then runs parser, importer and stdio end-to-end tests
npm run build:samples  # regenerates data/samples.json from the hmos-index skill references
npm run check:templates -- <project>  # compiles every template in a scratch copy of a HarmonyOS project

The component parser is a port of the IDE plugin's ComponentParser.kt; a test checks that both produce the same call for every catalog widget (test/fixtures/plugin-calls.txt). Environment variables:

Variable

Purpose

ARKUIBUILDER_CATALOG_FILE

Read the catalog from a saved getWidgetCatalog response instead of the network

ARKUIBUILDER_MY_WIDGETS

Path of the plugin's my-widgets.json

ARKUIBUILDER_SAMPLES_DIR

Read sample projects from local clones (<dir>/<repo>/…) instead of GitHub

GITHUB_TOKEN

Raises GitHub's rate limit for get_sample

Available Tools

3 tools
add_widgetAdd an ArkUIBuilder widget to the projectA
Idempotent

Copies a widget's component into /src/main/ets/components/.ets and adds its import to target_file. Returns the call to place in build(). Never overwrites a different existing file unless overwrite is true.

Inputs: name (required), target_file (required), overwrite.

get_widgetGet an ArkUIBuilder widgetA
Read-only

Details of one widget by component name (e.g. ColorStudioFb), id or title. Set include_code only if you need to read or adapt its source; to use it as-is call add_widget instead.

Inputs: name (required), include_code.

search_widgetsSearch ArkUIBuilder widgetsA
Read-only

Search ready-made HarmonyOS ArkUI components (ArkUIBuilder catalog plus the user's My Widgets). Each result shows the call to write in build() and its required parameters. Call with no arguments for an overview of platforms and categories.

Inputs: limit, query, category, platform.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4/5.0

    Scored across 3 tools

    Disambiguation4/5

    search_widgets (discover), get_widget (inspect source/details), and add_widget (install into module) have distinct actions, and the descriptions explicitly steer between them (e.g. 'to use it as-is call add_widget instead'). There is mild overlap since search results already return the build() call and parameters, making get_widget's unique value narrower, but the boundaries are clearly drawn.

    Naming Consistency5/5

    All three tools follow a clean verb_noun snake_case pattern: search_widgets, get_widget, add_widget. The convention is predictable and consistent throughout.

    Tool Count4/5

    Three tools is on the thin side, but the server's scope (search a widget catalog, inspect a widget, install it) is genuinely narrow, so each tool earns its place. A list-categories or remove-widget tool would round it out but the count is reasonable for the purpose.

    Completeness4/5

    The core lifecycle of discover -> inspect -> install is fully covered, including an overview mode (search with no args) and a copy/install operation. Minor gaps exist (no tool to remove or update an already-installed widget), but these are workarounds an agent can handle manually.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • F
      license
      Not graded
      quality
      B
      maintenance
      Enables AI coding assistants to search, discover, and retrieve UI HUB components, source code, dependencies, templates, and animations via MCP.
      -
    • A
      license
      Not graded
      quality
      B
      maintenance
      Enables coding agents to search, inspect, and retrieve real UI components from existing component libraries, with ranked results, score explanations, licence and provenance details, and safe installation plans. It also surfaces similar components and higher-level UI patterns so agents can reuse existing interface code instead of generating it from scratch.
      MIT
    • F
      license
      A
      quality
      B
      maintenance
      Enables AI assistants to search a catalogue of plain HTML, CSS and JavaScript UI components and fetch each one's exact files, settings and framework integration instructions. Lets users add production-ready interface components by asking in natural language.
      2
      2
      13
      -