Welcome to @sap/mdk-mcp-server

What is MCP server for mobile development kit?

This open-source server provides AI agents with comprehensive MDK knowledge and tools. By combining best practice guidelines, project-aware context information, templates for creating new projects, and access to the MDK CLI tools, the MDK MCP server transforms AI agents into MDK development experts.

What is mobile development kit?

The SAP Mobile Development Kit (MDK) is a powerful framework that enables developers to build cross-platform mobile applications using a metadata-driven approach. It is part of SAP Business Technology Platform and integrates tightly with SAP Mobile Services. Some of SAP’s larger and complex mobile apps are built using MDK. An example is SAP Service and Asset Manager.

[!NOTE] This MCP server is an early release version of the MDK. You may encounter bugs or unfinished features. We'd love your feedback to make it better! Please report issues or share suggestions via GitHub issues.

Table of Contents

• Setup
• Available Tools
• Support, Feedback, Contributing
• Telemetry
• Security / Disclosure
• Code of Conduct
• Licensing
• Acknowledgments

Setup

1. Install node.js 22.14.0.

2. For installing the MDK MCP server, we offer two options:

   a. Use npm to install it from the public npmjs registry at @sap/mdk-mcp-server.

   bash npm install -g @sap/mdk-mcp-server

   b. Clone the open-source code repository at https://github.com/SAP/mdk-mcp-server, and use npm to install.

   bash git clone https://github.com/SAP/mdk-mcp-server.git cd mdk-mcp-server npm i --include=optional npm run build npm i -g @sap/mdk-mcp-server@.

3. Configure your MCP client (AI agent) to connect to the server. Configuration will vary depending on the AI agent used.

   Cline in VS Code: Example using the Cline extension.

   • With Cline open, look below the prompt box and click Manage MCP Servers.
   • In the dialog, click Settings. The MCP Servers page opens.
   • Click Configure MCP Servers. This will open the cline_mcp_settings.json file in your editor.
   • In the JSON settings file, add a configuration block for MDK MCP server within the mcpServers section, and save the file. The supported schema versions include 26.3(default), 25.9, 25.6, 24.11, and 24.7.

   { "mcpServers": { "mdk-mcp": { "type": "stdio", "command": "mdk-mcp", "args": ["--schema-version", "26.3"] } } }

   Note:
   If the MCP server does not listed with its available tools in the Cline extension immediately, restart VS Code.

Expand: Usage in OpenCode

Example using [OpenCode](https://github.com/sst/opencode):

```
{
  "mcp": {
    "mdk-mcp": {
      "type": "local",
      "command": ["mdk-mcp", "--schema-version", "26.3"],
      "enabled": true
    }
  }
}
```

Expand: Usage in Cursor

Edit the file `~/.cursor/mcp.json`:

```
{
  "mcpServers": {
    "mdk-mcp": {
      "command": "mdk-mcp",
      "args": ["--schema-version", "26.3"]
    }
  }
}
```




Once configured, your AI agent will have access to the MDK MCP server. Depending on your IDE settings, you may need to approve initial tool calls.

1. Create a Rule File: To ensure your AI coding assistant uses the MCP servers appropriately for your project, define rules and guidelines in a file named AGENTS.md. In the Cline extension for VS Code, click the Manage Cline Rules & Workflows icon below the prompt box, click + to create a new rule file (e.g., AGENTS.md) and add the above contents.

   Example rules to guide agent behavior:

   markdown - Don't generate `.service.metadata` file. - Don't generate `.xml` file in the `Services` folder. - Don't change `.project.json` file.

2. Verify your LLM Provider and AI model.

   When you add Cline to VS Code, it uses Cline as the default API provider. You can choose a different LLM provider, such as SAP AI core. To add an SAP AI Core API provider in the Cline extension for VS Code, follow these steps: - With Cline open, look below the prompt box and click Select Model / API Providers. - Choose your API provider (such as SAP AI Core) and enter your details. See the instructions here for detailed setup. - Select your preferred AI model.

3. Integration with SAP Mobile Services: For creating a new MDK application, the MCP server uses the Cloud Foundry CLI and a .service.metadata file containing:

   • The mobile application defined in the SAP Mobile Services instance.
   • Mobile Services API Endpoint
   • Mobile Services App ID
   • Mobile Destinations including OData service metadata.

   We include a tool to help with creating or updating this file as part of our VS Code extension: Mobile development kit extension for VS Code. This is how you can use this tool to create or update the .service.metadata file:

   1. Install the Mobile development kit extension for VS Code version 1.32.0 or later.
   2. Install the Cloud Foundry CLI.
   3. Log in to your SAP BTP Cloud Foundry environment. For more details you can refer to this help documentation.

   bash cf login -a <your target endpoint> --sso

   1. Create an empty folder on your machine and open it in VS Code.
   2. Open the Command Palette in VS Code and select MDK: Open Mobile App Editor.
   3. Create a new or select an existing mobile app.
   4. Select a destination.
   5. Click Add App to Project.

4. Your environment is now ready for the MDK development with MCP server. You can now enter a prompt to:

   • Generate a new MDK project displaying OData entities information.
   • Enhance an existing project adding additional UI controls on a given page.
   • Validate your current MDK project schema.
   • Migrate old MDK projects to latest schema.
   • Deploy your MDK project.
   • Generate onboarding QR code.
   • Explain specific properties.
   • Find information about control properties or any aspect of the documentation.

Available Tools

[!NOTE] Tools are meant to be used by AI models and do not constitute a stable API.

This release of the MDK MCP server includes the following tools, which can be accessed by your AI agent:

• scope: The scope of creation:

• project: Initialize a new MDK project with full structure

• entity: Add entity metadata to an existing project

• templateType: The type of template to use (crud, list detail, base). Note: 'base' template is only valid for project scope.

• oDataEntitySets: The OData entity sets relevant to the user prompt, separated by commas.

• offline: Whether to generate the project in offline mode (only applicable for project scope). Set to false unless offline is explicitly specified. | | mdk-gen | Generates MDK artifacts including pages, actions, i18n files, and rule references. Returns prompts for LLM processing (pages, actions, i18n) or searches for rule examples. | - artifactType: The type of artifact to generate:

• page: Generate MDK page files (.page) with databinding or layout

• action: Generate MDK action files (.action)

• i18n: Generate internationalization files (.properties)

• rule: Search for and return relevant JavaScript rule examples

• folderRootPath: The path of the current project root folder (not required for rule artifact type).

For page artifacts:

• pageType: Type of page (required when artifactType is 'page'):

• databinding: Data-driven pages with controls bound to OData

• layout: Structure-focused pages with specific layouts

• controlType: The control type for databinding pages (required when pageType is 'databinding'). Available types: ObjectTable, FormCell, KeyValue, ObjectHeader, ContactTable, SimplePropertyCollection, ObjectCard, DataTable, KPIHeader, ProfileHeader, ObjectCollection, Timeline, TimelinePreview, Calendar.

• oDataEntitySets: Optional: The OData entity sets to use for page generation, separated by commas (required only when pageType is 'databinding').

• layoutType: The layout type for layout pages (required when pageType is 'layout'). Available types: Section, BottomNavigation, FlexibleColumnLayout, SideDrawerNavigation, Tabs, Extension.

For action artifacts:

• actionType: The type of action (required when artifactType is 'action'). Available types: CreateODataEntity, UpdateODataEntity, DeleteODataEntity, CreateODataMedia, InitializeOfflineOData, DownloadOfflineOData, UploadOfflineOData, CancelDownloadOfflineOData, CancelUploadOfflineOData, ClearOfflineOData, CloseOfflineOData, CreateODataRelatedEntity, CreateODataRelatedMedia, CreateODataService, DeleteODataMedia, DownloadMediaOData, LogMessage, Message, Navigation, OpenODataService, ProgressBanner, PushNotificationRegister, PushNotificationUnregister, ReadODataService, RemoveDefiningRequest, SendRequest, SetLevel, SetState, ToastMessage, UndoPendingChanges, UploadLog, UploadODataMedia, UploadStreamOData, ChatCompletion, PopoverMenu, CheckRequiredFields, ChangeSet, OpenDocument, Banner, Filter.

• oDataEntitySets: Optional: The OData entity sets to use for action generation, separated by commas (required only when artifactType is 'action').

For i18n artifacts:

• No additional parameters required beyond folderRootPath.

For rule artifacts:

• query: Search query for rule reference (required when artifactType is 'rule'). Examples: 'get app name', 'handle form validation', 'navigate to page', etc. | | mdk-manage | Comprehensive MDK project management tool that handles build, deploy, validate, migrate, show QR code, and mobile app editor operations. | - folderRootPath: The path of the current project root folder.

• operation: The operation to perform on the MDK project. Available operations:

• build: Build an MDK project

• deploy: Deploy an MDK project to the Mobile Services

• validate: Validate an MDK project

• migrate: Migrate an MDK project to the latest MDK version

• show-qrcode: Show QR code for an MDK project

• open-mobile-app-editor: Instruct how to open the Mobile App Editor to create .service.metadata file

• externals: Optional: Array of external package names to include in the deployment (e.g., ['@nativescript/geolocation']). If not specified, will automatically read from mdk.bundlerExternals in .vscode/settings.json of the project. Defaults to empty array if neither is provided. | | mdk-docs | Unified tool for accessing MDK documentation including search, component schemas, property details, and examples. | - operation: The type of documentation operation to perform:

• search: Returns the top N results from MDK documentation by semantic search, sorted by relevance

• component: Returns the schema of an MDK component based on the name of the component

• property: Returns the documentation of a specific property of an MDK component

• example: Returns an example usage of an MDK component

• folderRootPath: The path of the current project root folder. Used to determine the appropriate MDK schema version.

• query: Search query string (required for 'search' operation).

• component_name: Name of the component (required for 'component', 'property', and 'example' operations).

• property_name: Name of the property (required for 'property' operation).

• N: Number of results to return for search operation (default: 5). |

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports, and so on, via GitHub issues. Contribution and feedback are encouraged and always welcome.

These instructions help contributors set up, test, and maintain code quality for this project. All commands should be run from your project folder in a terminal.

• Test: npm test
• Build: npm run build
• Lint: npm run lint:all

For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contributio