Arm MCP Server

An MCP server providing AI assistants with tools and knowledge for Arm architecture development, migration, and optimization.

Using the Arm MCP Server

If your goal is to migrate an application from x86 to Arm as quickly as possible, start here:

Automate x86-to-Arm application migration using Arm MCP Server

Features

This MCP server equips AI assistants with specialized tools for Arm development:

• Knowledge Base Search: Semantic search across Arm documentation, learning resources, intrinsics, and software compatibility information
• Code Migration Analysis: Scan codebases for Arm compatibility using migrate-ease (supports C++, Python, Go, JavaScript, Java)
• Container Architecture Inspection: Check Docker image architecture support using integrated Skopeo and check-image tools.
• Assembly Performance Analysis: Analyze assembly code performance using LLVM-MCA
• Arm Performix: Run APX recipe workflows against a target device over SSH to capture and analyze workload performance data
• System Information: Instructions for gathering detailed system architecture information via sysreport

Pre-Built Image

If you would prefer to use a pre-built, multi-arch image, the official image can be found in Docker Hub here: armlimited/arm-mcp:latest

Prerequisites

• Docker (with buildx support for multi-arch builds)
• An MCP-compatible AI assistant client (e.g. GitHub Copilot, Kiro CLI, Codex CLI, Claude Code, etc)

Quick Start

1. Build the Docker Image

From the root of this repository:

docker buildx build --platform linux/arm64,linux/amd64 -f mcp-local/Dockerfile -t armlimited/arm-mcp .

For a single-platform build (faster):

docker buildx build -f mcp-local/Dockerfile -t armlimited/arm-mcp . --load

2. Configure Your MCP Client

Choose the configuration that matches your MCP client:

The examples below include the optional Docker arguments required for Arm Performix. These SSH-related settings are only needed when you want the MCP server to run remote commands on a target device through Arm Performix. If you are not using Arm Performix, you can omit the SSH -v lines.

#### Claude Code

Add to .mcp.json in your project:

{
  "mcpServers": {
    "arm-mcp": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--pull=always",
        "-v", "/path/to/your/workspace:/workspace",
        "-v", "/path/to/your/ssh/private_key:/run/keys/ssh-key.pem:ro",
        "-v", "/path/to/your/ssh/known_hosts:/run/keys/known_hosts:ro",
        "armlimited/arm-mcp"
      ]
    }
  }
}

#### GitHub Copilot (VS Code)

Add to .vscode/mcp.json in your project, or globally at ~/Library/Application Support/Code/User/mcp.json (macOS):

{
  "servers": {
    "arm-mcp": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--pull=always",
        "-v", "/path/to/your/workspace:/workspace",
        "-v", "/path/to/your/ssh/private_key:/run/keys/ssh-key.pem:ro",
        "-v", "/path/to/your/ssh/known_hosts:/run/keys/known_hosts:ro",
        "armlimited/arm-mcp"
      ]
    }
  }
}

The easiest way to open this file in VS Code for editing is command+shift+p and search for

MCP: Open User Configuration

#### AWS Kiro CLI

Add to ~/.kiro/settings/mcp.json:

{
  "mcpServers": {
    "arm-mcp": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--pull=always",
        "-v", "/path/to/your/workspace:/workspace",
        "-v", "/path/to/your/ssh/private_key:/run/keys/ssh-key.pem:ro",
        "-v", "/path/to/your/ssh/known_hosts:/run/keys/known_hosts:ro",
        "armlimited/arm-mcp"
      ],
      "timeout": 60000
    }
  }
}

#### Gemini CLI

It is recommended to use a project-local configuration file to ensure the relevant workspace is mounted.

Add to .gemini/settings.json in your project root:

{
  "mcpServers": {
    "arm-mcp": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--pull=always",
        "-v", "/path/to/your/workspace:/workspace",
        "-v", "/path/to/your/ssh/private_key:/run/keys/ssh-key.pem:ro",
        "-v", "/path/to/your/ssh/known_hosts:/run/keys/known_hosts:ro",
        "armlimited/arm-mcp"
      ]
    }
  }
}

#### MCP Clients using TOML format (e.g. Codex CLI)

[mcp_servers.arm-mcp]
command = "docker"
args = [
  "run",
  "--rm",
  "-i",
  "--pull=always",
  "-v", "/path/to/your/workspace:/workspace",
  "-v", "/path/to/your/ssh/private_key:/run/keys/ssh-key.pem:ro",
  "-v", "/path/to/your/ssh/known_hosts:/run/keys/known_hosts:ro",
  "armlimited/arm-mcp"
]

Note: Replace /path/to/your/workspace with the actual path to your project directory that you want the MCP server to access. If you are enabling Arm Performix, also replace the /path/to/your/ssh/private_key and /path/to/your/ssh/known_hosts paths with your local files. The MCP container auto-discovers files mounted under /run/keys, as shown in the configs above.

3. Restart Your MCP Client

After updating the configuration, restart your MCP client to load the Arm MCP server.

Repository Structure

• `mcp-local/`: The MCP server implementation
• server.py: Main FastMCP server with tool definitions
• utils/: Helper modules for each tool
• data/: Pre-built knowledge base (embeddings and metadata)
• Dockerfile: Multi-stage Docker build
• `embedding-generation/`: Scripts for regenerating the knowledge base from source documents

Integration Testing

Pre-requisites

• Build the mcp server docker image
• Install the required test packages using - pip install -r tests/requirements.txt within the mcp_local directory.

Testing Steps

• Run the test script - python -m pytest -s tests/test_mcp.py
• Check if following 2 docker containers have started - mcp server & testcontainer
• All tests should pass without any errors. Warnings can be ignored.

Troubleshooting

Accessing the Container Shell

To debug or explore the container environment:

docker run --rm -it --entrypoint /bin/bash armlimited/arm-mcp

Common Issues

• Timeout errors during migration scans: Increase the timeout value in your MCP client configuration (e.g., "timeout": 120000 for 2 minutes)
• Empty workspace: Ensure your volume mount path is correct and the directory exists
• Architecture mismatches: If you encounter platform-specific issues, rebuild for your specific platform using --platform linux/amd64 or --platform linux/arm64

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

When contributing:

• Follow PEP 8 style guidelines for Python code
• Update documentation for any new features or changes
• Ensure the Docker image builds successfully before submitting

License

Copyright © 2025, Arm Limited and Contributors. All rights reserved.

Licensed under the Apache License, Version 2.0. See LICENSE for details.