Welcome to @sap/mdk-mcp-server

What is MCP server for Mobile Development Kit (MDK)?

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 mobile development kit 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.

Table of Contents

• Setup
• Available Tools
• Ingesting GitHub Knowledge (Advanced)
• Offline OData Querying (Advanced)
• Support, Feedback, Contributing
• Telemetry
• Security / Disclosure
• Code of Conduct
• Licensing
• Acknowledgments

Setup

Platform Support

The MDK MCP server supports the following platforms:

• macOS: Apple Silicon (ARM64) only
  • ⚠️ Note: Intel Mac (x64) is not supported in v0.4.0+ due to onnxruntime-node ≥1.24 dropping darwin/x64 binaries
• Linux: x64, ARM64, and other architectures
• Windows: x64, ARM64

If you're on an Intel Mac, you may need to:

• Use Rosetta 2 to run the ARM64 version (performance may vary)
• Or stay on an earlier version that uses onnxruntime-node <1.24

Installation Steps

1. Install node.js 24.11.1.

2. To install the MDK MCP server, you have two options:

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

   Terminal

   Copy

   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

   Copy

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

3. Configure your MCP client (AI agent) to connect to the server. Note that 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.6 (default), 26.3, 25.9, 25.6, 24.11, and 24.7.
   config.json

   Copy

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

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

   Expand: Usage in Claude Code (VS Code Extension)

   Claude Code discovers MCP servers from its configuration.

   1. Open (or create) your Claude Code configuration file:

   text

   Copy

   ~/.claude.json
   

   2. Add the following MCP server configuration:

   config.json

   Copy

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

   Note: If ~/.claude.json already exists, merge the mdk-mcp entry into the existing mcpServers section rather than replacing the entire file.

   3. Reload the VS Code window (or restart VS Code).

   Verify the installation

   Open the Claude Code panel in VS Code and run:

   text

   Copy

   /mcp
   

   You should see mdk-mcp listed as an available MCP server.

   Expand: Usage in OpenCode

   An example using OpenCode:

   JSON Config

   Copy

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

   Expand: Usage in Cursor

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

   config.json

   Copy

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

   Expand: Usage in Claude Desktop

   Use the absolute path to Node.js in your Claude Desktop configuration file.

   1. Find your Node.js installation path by running the terminal command:

      bash

      Copy

      which node
      

      This might output something like /usr/local/bin/node or /opt/homebrew/bin/node.

   2. Edit ~/Library/Application Support/Claude/claude_desktop_config.json and update the command field to use the absolute path:

      config.json

      Copy

      {
        "mcpServers": {
          "mdk-mcp": {
            "command": "/usr/local/bin/node",
            "args": ["/usr/local/lib/node_modules/@sap/mdk-mcp-server/build/index.js", "--schema-version", "26.6"]
          }
        }
      }
      

   3. Restart Claude Desktop.

   Note: Adjust the paths based on your actual Node.js and MDK MCP server installation locations.

   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.

4. 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 example rules shown below:

   markdown

   Copy

   - Do not generate `.service.metadata` file.
   - Do not generate `.xml` file in the `Services` folder.
   - Do not change `.project.json` file.
   

5. Verify your LLM Provider and AI model.

   When you add Cline to VS Code, it serves 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 a detailed setup.
   • Select your preferred AI model.

6. Integration with SAP Mobile Services: To create 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

   Copy

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

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

7. 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 by 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: