Skip to content

README.md

Latest commit

 

History

History
67 lines (49 loc) · 3 KB

README.md

File metadata and controls

67 lines (49 loc) · 3 KB

UI5 Plugin for Coding Agents

Complete SAPUI5 / OpenUI5 plugin for coding agents with MCP tools, API documentation access, linting capabilities, and development guidelines.

Key Features

🛠️ MCP Tools

  • Create and validate UI5 projects - Project scaffolding and validation
  • Access API documentation - Query UI5 control APIs and documentation
  • Run UI5 linter - Code quality validation and best practices checks
  • UI5 tooling integration - Version info and project management

📋 Skills

ui5-best-practices

Development guidelines and coding standards derived from official SAP UI5 guidelines:

  • Async module loading - sap.ui.define patterns
  • Data binding with OData types - Type-safe data binding
  • CSP compliance - Content Security Policy best practices
  • TypeScript event handlers - Modern event handling (UI5 >= 1.115.0)
  • CAP integration - Integration with SAP Cloud Application Programming Model
  • Form creation rules - Form and SimpleForm patterns
  • i18n management - Internationalization workflows
  • Component initialization - ComponentSupport patterns

Note: For TypeScript conversion specifically, use the separate ui5-typescript-conversion plugin.

ui5-best-practices-integration-cards

Development guidelines for UI Integration Cards (also known as UI5 Integration Cards):

  • Declarative card types - List, Table, Calendar, Timeline, Object, Analytical
  • Building a card - Structure of the declarative manifest.json format for a UI Integration Card
  • Parameter and destination binding - {parameters>/key/value} and {{destinations.name}} syntax
  • Data rules - Where the data block goes (sap.card/data/content/data/header/data), wrapping URLs in destinations, and requiring JSON responses
  • Manifest validation - JSON, schema, and deprecated-property checks before declaring done
  • Local preview workflow - Reusing existing entry points or serving via a <ui-integration-card> HTML page
  • Configuration Editor patterns - dt/Configuration.js paired with manifest.json, mirroring fields and manifestpath targets
  • Analytical cards - 44 chart types with required UIDs, feeds, and per-type examples
  • i18n - Bind all user-facing strings to the i18n model; never hardcode
  • Actions - Use the actions property for links and interactions; never inline <a> tags or hand-roll URL handlers

Installation

Via Claude CLI

claude plugin install ui5@claude-plugins-official

In Claude Code

/plugin install ui5@claude-plugins-official

Installing Skills Only

If your coding agent doesn't support plugins, install the skills directly using the skills package:

npx skills add UI5/plugins-coding-agents

Note: When installing the skills only, you will need to install the UI5 MCP server manually.