generate-interface-uml

Generate PlantUML sequence and class diagrams for OpenHarmony interfaces from reference call chains.

31|6|Updated Jan 29, 2026
One-click install
npx skills add https://github.com/openharmonyinsight/openharmony-skills --skill generate-interface-uml
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-interface-uml
Source: https://github.com/openharmonyinsight/openharmony-skills/tree/main/skills/generate-interface-uml
Command: npx skills add https://github.com/openharmonyinsight/openharmony-skills --skill generate-interface-uml

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When designing or reviewing new OpenHarmony interfaces, it’s hard to quickly visualize how client calls traverse IPC layers and reach the final target classes, which slows down alignment and increases design mistakes.

Core Features & Use Cases

  • PlantUML sequence diagram generation: Produces a clear end-to-end call flow (client → interface → IPC → service thread → target execution) in a structured diagram.
  • PlantUML class diagram generation: Builds a relationship map between client/service/static layers and the relevant IPC connection and agent components.
  • Reference-based diagram construction: Uses an existing similar interface implementation to infer the call chain and generate accurate UML for the new interface.

Typical Use Case: You introduce a new API method and want stakeholders to understand the IPC and thread execution path without manually drawing diagrams from scratch.

Quick Start

Ask the AI to generate UML for your new interface by providing the interface name(s), parameter/return types, a similar reference interface in the codebase, the ultimately called target class, and the output directory.

Frequently Asked Questions about generate-interface-uml

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a PlantUML sequence diagram for an OpenHarmony interface call flow?

To generate a PlantUML sequence diagram for an OpenHarmony interface, provide the new interface name, parameters, a similar reference interface, and the target class. The tool infers the call chain to produce a client, IPC, and service thread execution flow diagram.

Can I visualize IPC flow and class relationships for new API methods without drawing from scratch?

You can visualize IPC flow and class relationships by supplying an existing reference implementation. The tool automatically infers participants and method calls to build the relationship map between client, service, and IPC agent components.

What is the best way to document client-to-service pathways in OpenHarmony?

The best way to document client-to-service pathways in OpenHarmony is generating PlantUML artifacts. By using a reference call chain, the tool outputs structured sequence and class diagrams showing end-to-end thread scheduling and target execution.

Does this approach require a specific reference interface to build class diagrams for API design?

Yes, generating accurate class diagrams for API design requires a similar reference interface from your codebase. The tool uses this existing implementation to infer the structural relationships and IPC connections for your newly modified interface.

How to map static structure and thread scheduling steps for an IPC interface modification?

To map static structure and thread scheduling steps, input the modified interface details alongside a reference target class. The tool generates UTF-8 PlantUML artifacts capturing the inferred participants, method calls, and task execution pathways.

What information do I need to prepare for OpenHarmony UML generation?

You need to prepare the new interface name, parameter and return types, a similar reference interface, the ultimately called target class, and an output directory. This information allows the tool to infer the call chain and generate the diagrams.