List all available UI5 MCP server tools and their usage
Lists all available UI5 MCP server tools and their usage instructions.
/plugin marketplace add secondsky/sap-skills/plugin install sapui5@sap-skillsThis command lists all available tools provided by the @ui5/mcp-server (Model Context Protocol server for UI5 development).
The Model Context Protocol (MCP) is an open standard that allows AI assistants like Claude to connect with external tools and services. The @ui5/mcp-server provides 9 specialized tools for SAPUI5/OpenUI5 development.
Purpose: Scaffold new UI5 applications with various templates
Templates:
Usage:
create_ui5_app({
template: "freestyle-ts",
projectName: "my-ui5-app",
namespace: "com.mycompany.myapp",
ui5Version: "1.120.0",
odataVersion: "v4",
enableCAP: false
})
Agent: Used by ui5-app-scaffolder
Command: /ui5-scaffold
Purpose: Scaffold Integration Cards for SAP Work Zone, launchpad, or standalone widgets
Card Types:
Usage:
create_integration_card({
cardType: "List",
cardName: "sales-dashboard",
namespace: "com.mycompany.cards"
})
Agent: Used by ui5-app-scaffolder
Command: /ui5-scaffold --type=integration-card
Purpose: Static code analysis for UI5 projects
Checks For:
Usage:
run_ui5_linter({
files: ["webapp/**/*.js", "webapp/**/*.xml"],
fix: false, // Set to true for auto-fix
config: {
rules: {
"no-deprecated-api": "error",
"no-globals": "error",
"async-module-loading": "error"
}
}
})
Agent: Used by ui5-code-quality-advisor
Command: /ui5-lint
Purpose: Extract metadata from UI5 projects
Returns:
Usage:
get_project_info({
projectPath: "./webapp"
})
Agent: Used by all agents for context awareness Command: None (internal tool)
Purpose: Fetch UI5 API documentation for controls, methods, events, and properties
Features:
Usage:
get_api_reference({
control: "sap.m.Table",
version: "1.120.0",
includeExamples: true,
includeDeprecated: false
})
Agent: Used by ui5-api-explorer
Command: /ui5-api sap.m.Table
Purpose: Retrieve SAP UI5 best practice guidelines
Topics:
Usage:
get_guidelines({
topic: "controller-patterns",
version: "1.120.0"
})
Agent: Used by ui5-code-quality-advisor
Command: None (used internally for code reviews)
Purpose: UI5 version information, release notes, and migration paths
Returns:
Usage:
get_version_info({
version: "1.120.0",
compareWith: "1.108.0" // Optional: show differences
})
Agent: Used by ui5-migration-specialist, ui5-code-quality-advisor
Command: /ui5-version 1.120.0
Purpose: Guidelines for converting JavaScript UI5 projects to TypeScript
Provides:
Usage:
get_typescript_conversion_guidelines({
projectPath: "./webapp"
})
Agent: Used by ui5-migration-specialist
Command: None (used for TypeScript migration)
Purpose: Best practices for developing SAP Integration Cards
Topics:
Usage:
get_integration_cards_guidelines({
cardType: "List"
})
Agent: Used by ui5-app-scaffolder
Command: None (used during Integration Card scaffolding)
npm install -g @ui5/mcp-server
npx -y @ui5/mcp-server <tool-name> <arguments>
The sapui5 plugin automatically configures MCP via .mcp.json:
{
"ui5-tooling": {
"command": "npx",
"args": ["-y", "@ui5/mcp-server"],
"env": {
"UI5_PROJECT_DIR": "${cwd}",
"UI5_VERSION": "1.120.0",
"UI5_MCP_SERVER_RESPONSE_NO_RESOURCES": "true"
}
}
}
This configuration is already set up in the sapui5 plugin - no manual setup needed!
Uses:
create_ui5_app - Create projectscreate_integration_card - Create cardsget_project_info - Validate scaffoldingUses:
get_api_reference - Fetch API docsget_version_info - Check version compatibilityUses:
run_ui5_linter - Static analysisget_guidelines - Best practicesget_version_info - Deprecation checksUses:
get_version_info - Migration pathsget_typescript_conversion_guidelines - TypeScript conversionrun_ui5_linter - Post-migration validationget_api_reference - New API documentationAll agents have graceful fallback when MCP tools are unavailable:
If MCP unavailable, agents use:
references/templates/This ensures 100% functionality even without MCP server.
With MCP (Recommended):
Without MCP (Fallback):
To check if MCP tools are available:
# Test MCP server
npx -y @ui5/mcp-server --help
# Expected output: List of available tools
If this works, all agents will automatically use MCP tools for faster, more accurate results.
# Install globally
npm install -g @ui5/mcp-server
# Or use npx (automatic download)
npx -y @ui5/mcp-server --version
# Fix npm permissions
sudo chown -R $USER ~/.npm
sudo chown -R $USER /usr/local/lib/node_modules
# Check npm registry
npm config get registry
# Try different registry
npm config set registry https://registry.npmjs.org/
MCP Server Documentation:
https://github.com/UI5/mcp-server
SAP Community Blog:
https://community.sap.com/t5/technology-blog-posts-by-sap/give-your-ai-agent-some-tools-introducing-the-ui5-mcp-server/ba-p/14200825
Detailed MCP Integration Guide:
See plugins/sapui5/skills/sapui5/references/mcp-integration.md
The UI5 MCP server provides 9 powerful tools for:
All tools are automatically available to the sapui5 plugin agents and commands!
Happy developing with MCP! 🚀