Skip to main content

Arm MCP Server - Provides AI assistants with tools for Arm architecture development, migration, and optimization

Project description

Arm MCP Server

An Model Context Protocol (MCP) server providing AI assistants with tools and knowledge for Arm architecture development, migration, and optimization.

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
  • 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:

Claude Code

Add to .mcp.json in your project:

{
  "mcpServers": {
    "arm-mcp": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-v", "/path/to/your/workspace:/workspace",
        "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",
        "-v", "/path/to/your/workspace:/workspace",
        "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",
        "-v", "/path/to/your/workspace:/workspace",
        "--name", "arm-mcp",
        "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",
        "-v", "/path/to/your/workspace:/workspace",
        "armlimited/arm-mcp"
      ]
    }
  }
}

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

[mcp_servers.arm-mcp]
command = "docker"
args = [
  "run",
  "--rm",
  "-i",
  "-v", "/path/to/your/workspace:/workspace",
  "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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_arm_arm_mcp-0.1.0.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_arm_arm_mcp-0.1.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_arm_arm_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_arm_arm_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_arm_arm_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6bfbf62446602fc65ee0bd407740fe0de68644200a05176a804936f59e18d5ce
MD5 5b0b653eacb34fca63e2b577bdeac7bb
BLAKE2b-256 c0e5e4dcad3b8519a6061f11ea286b05480ad9d19c3929175fb9b294789521c3

See more details on using hashes here.

File details

Details for the file iflow_mcp_arm_arm_mcp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_arm_arm_mcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_arm_arm_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e9a7497c7c649c1b68fea35802fe030ee36e6ee49607624a77b61bc28bc31464
MD5 f5347d42a05aec8f7b0ae4dfb6344351
BLAKE2b-256 209f357f0a962b5c9499bad0dcdac1f324159625901d94f06bad9cb2f963c5e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page