UI5

UI5 MCP 服务

用于 UI5 应用开发的 Model Context Protocol 服务。

描述

UI5 Model Context Protocol 服务提供各种工具，帮助开发者在使用 Agentic AI 工具时提升开发体验。

主要功能

• 使用 Agentic AI 工具时，帮助创建新的 UI5 项目
• 帮助开发者检测并修复代码中的 UI5 特定错误
• 为 Agentic AI 工具提供额外的 UI5 特定信息

提示

也请查看我们在 SAP Community 发布的公告博客文章！

可用工具

• create_integration_card：搭建新的 UI Integration Card。
• create_ui5_app：基于一组模板搭建新的 UI5 应用。
• get_api_reference：获取并格式化 UI5 API 文档。
• get_guidelines：提供 UI5 开发最佳实践。
• get_integration_cards_guidelines：提供 UI Integration Cards 开发最佳实践。
• get_project_info：从 UI5 项目中提取元数据和配置。
• get_typescript_conversion_guidelines：提供将 UI5 应用和控件从 JavaScript 转换为 TypeScript 的指南。
• get_version_info：获取 UI5 框架的版本信息。
• run_manifest_validation：根据 UI5 Manifest 架构验证 manifest。
• run_ui5_linter：集成 @ui5/linter，分析并报告 UI5 代码中的问题。

要求

• Node.js 版本 v20.17.0、v22.9.0 或更高版本
• npm 版本 v8.0.0 或更高版本
• MCP 客户端，例如 VS Code（GitHub Copilot）、Cline、Claude Code、Codex 或任何其他兼容 MCP 的客户端

设置

适用于大多数客户端的标准配置

此配置适用于大多数 MCP 客户端：

{
    "mcpServers": {
        "@ui5/mcp-server": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "-y",
                "@ui5/mcp-server"
            ]
        }
    }
}

{
    "mcpServers": {
        "@ui5/mcp-server": {
            "type": "stdio",
            "command": "cmd",
            "args": [
                "/c",
                "npx -y @ui5/mcp-server"
            ]
        }
    }
}

特定 MCP 客户端

除了上面介绍的通用配置外，一些 MCP 客户端还提供安装 MCP 服务的快捷方式。下面列出了几种常见客户端的安装说明；如需了解更多信息，也可以查阅对应客户端的文档。

VS Code

首选： 从 GitHub MCP 服务注册表 安装

或者，你也可以使用 VS Code CLI：

# Using VS Code CLI
code --add-mcp '{"name":"@ui5/mcp-server","type": "stdio","command":"npx","args":["-y", "@ui5/mcp-server"]}'

Cline

1. 在 VSCode 中打开 Cline 面板。
2. 点击顶部“加号”符号旁边的“MCP Servers”图标
3. 切换到“Configure”选项卡，然后点击“Configure MCP servers”
4. 在打开的编辑器中，插入上面的适用于大多数客户端的标准配置

详情请参阅 docs.cline.bot/mcp/adding-and-configuring-servers。

Claude Code

claude mcp add --transport stdio --scope user ui5-mcp-server -- npx -y @ui5/mcp-server

Codex

codex mcp add --transport stdio ui5-mcp-server -- npx -y @ui5/mcp-server

向项目添加规则

以下规则指导大语言模型（LLM）正确使用 UI5 MCP 服务。请将这些规则添加到现有的全局或项目专属 AGENTS.md 文件中。具体位置可能因 MCP 客户端而异。例如，Claude Code 使用 CLAUDE.md 文件，而不是 AGENTS.md。

## Guidelines for UI5

Use the `get_guidelines` tool of the UI5 MCP server to retrieve the latest coding standards and best practices for UI5 development.

配置

UI5 MCP 服务可通过以下环境变量进行配置。它不接受任何命令行参数。

配置选项：

• UI5_MCP_SERVER_ALLOWED_DOMAINS：
  • 默认值：localhost, services.odata.org
  • 描述：允许在各种工具中使用的域名列表，以逗号分隔，例如：localhost, example.com, sub.example.com。设置为空字符串可允许使用任何域名。 对于通配符子域名，请在域名前添加一个点：.example.com。这会匹配 www.example.com，但不会匹配 example.com。
• UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT：
  • 描述：设置为任意值即可在 MCP 服务响应中禁用结构化内容。
• UI5_MCP_SERVER_RESPONSE_NO_RESOURCES：
  • 描述：设置为任意值即可在 MCP 服务响应中禁用资源。这对不支持资源的客户端很有用，例如 Cursor 或 Gemini CLI。
• UI5_MCP_SERVER_CDN_URL：
  • 默认值：OpenUI5 为 https://sdk.openui5.org，SAPUI5 为 https://ui5.sap.com
  • 描述：覆盖用于从 CDN 获取 UI5 资源的基础 URL。例如：https://example.com。设置后，此 URL 将用于 OpenUI5 和 SAPUI5 资源。该值必须是有效的 URL。请注意，项目的版本会自动附加到 URL 中。这意味着在运行时，URL 可能如下所示：https://example.com/1.120.0/resources/[...]。
• UI5_LOG_LVL：
  • 默认值：info
  • 描述：内部日志级别：silent、error、warn、info、perf、verbose、silly
• UI5_DATA_DIR：
  • 默认值：用户主目录中的 .ui5 目录
  • 描述：MCP 服务用于存储数据的目录，例如缓存的 API 参考资料。

支持、反馈与贡献

本项目欢迎通过 GitHub issues 提交功能请求／建议、错误报告等。我们鼓励并始终欢迎贡献和反馈。有关如何贡献、项目结构以及其他贡献信息，请参阅贡献指南。

你也可以在 OpenUI5 Community Slack 的 #tooling 频道中与我们交流。如需公开问答，请使用 Stack Overflow 上的 ui5-tooling 标签。

安全／披露

如果你发现可能存在安全问题的错误，请按照我们的安全政策中的说明进行报告。请勿针对安全相关的疑虑或问题创建 GitHub issues。

行为准则

作为社区成员、贡献者和领导者，我们承诺为每个人营造不受骚扰的参与体验。参与本项目即表示你同意始终遵守我们的行为准则。

许可

版权所有 © 2026 SAP SE 或 SAP 关联公司及 UI5 MCP 服务贡献者。有关版权和许可信息，请参阅我们的 LICENSE。包括第三方组件及其许可／版权信息在内的详细信息，可通过 REUSE 工具查看。