Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 3 additions & 24 deletions content/install-guides/antigravity.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,6 @@ Add the following JSON configuration to `~/.gemini/antigravity-cli/mcp_config.js
"--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:latest"
],
"env": {}
Expand All @@ -221,7 +217,7 @@ Add the following JSON configuration to `~/.gemini/antigravity-cli/mcp_config.js
}
```

Replace `/path/to/your/workspace`, `/path/to/your/ssh/private_key`, and `/path/to/your/ssh/known_hosts` with your workspace directory, SSH private key, and `known_hosts` file to enable remote testing features on your target device.
Replace `/path/to/your/workspace` with your workspace directory.

### (Optional) Use alternative container tools

Expand Down Expand Up @@ -251,10 +247,6 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
"--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:latest"
],
"env": {}
Expand Down Expand Up @@ -284,10 +276,6 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
"--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:latest"
],
"env": {}
Expand Down Expand Up @@ -319,10 +307,6 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
"--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:latest"
],
"env": {}
Expand Down Expand Up @@ -354,10 +338,6 @@ Add the following configuration to `~/.gemini/antigravity-cli/mcp_config.json`:
"--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:latest"
],
"env": {}
Expand Down Expand Up @@ -388,8 +368,8 @@ The output lists the Arm MCP Server tools and is similar to:
MCP Servers

Plugins (~/.gemini/antigravity-cli/plugins)
> ✓ arm_mcp_server Tools: knowledge_base_search, check_image, sysreport_instructions,
migrate_ease_scan, apx_recipe_run, +2 more
> ✓ arm_mcp_server Tools: knowledge_base_search, migrate_ease_scan, check_image,
skopeo, mca
```


Expand All @@ -406,4 +386,3 @@ If you are facing issues or have questions, reach out to mcpserver@arm.com.
You're now ready to use Antigravity CLI for Arm architecture development, migration, and optimization.

To test a workflow for migrating an application from x86 to Arm, see the Learning Path [Automate x86-to-Arm application migration using the Arm MCP server](/learning-paths/servers-and-cloud-computing/arm-mcp-server/).

18 changes: 8 additions & 10 deletions content/install-guides/claude-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ Navigate to your project directory and add the Arm MCP Server:

```console
cd your-project
claude mcp add --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/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:latest
claude mcp add --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/workspace" armlimited/arm-mcp:latest
```

This configuration is stored in `~/.claude.json` under your project's path and is only accessible when working in this directory.
Expand All @@ -194,7 +194,7 @@ This configuration is stored in `~/.claude.json` under your project's path and i
To make the Arm MCP Server available across all your projects:

```console
claude mcp add --scope user --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/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:latest
claude mcp add --scope user --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/workspace" armlimited/arm-mcp:latest
```

This configuration is stored in `~/.claude.json` and is accessible from any project directory.
Expand All @@ -205,7 +205,7 @@ To share the MCP server configuration with your team via version control:

```console
cd your-project
claude mcp add --scope project --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/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:latest
claude mcp add --scope project --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/workspace" armlimited/arm-mcp:latest
```

This creates a `.mcp.json` file in your project root that can be committed to version control.
Expand All @@ -217,11 +217,9 @@ The Arm MCP Server automatically mounts your current working directory to the `/
To analyze a different directory, modify the volume mount in the `docker run` command. For example, to analyze `/Users/username/myproject`:

```console
claude mcp add --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "/Users/username/myproject:/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:latest
claude mcp add --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "/Users/username/myproject:/workspace" armlimited/arm-mcp:latest
```

To enable Arm Performix features through the Arm MCP Server, replace `/path/to/your/ssh/private_key` and `/path/to/your/ssh/known_hosts` with the SSH private key and `known_hosts` file used for your target device.

### Optional: Use a Docker replacement containerization tool

You can use other containerization tools besides Docker that are free and do not require licenses, such as Podman, Finch, Colima, and Rancher Desktop. Choose one of the options below and use its CLI in place of `docker`.
Expand All @@ -238,7 +236,7 @@ podman pull armlimited/arm-mcp:latest
To make the Arm MCP Server available across all your projects (user scope):

```console
claude mcp add --scope user --transport stdio arm-mcp -- podman run --rm -i --pull=always -v "$(pwd):/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:latest
claude mcp add --scope user --transport stdio arm-mcp -- podman run --rm -i --pull=always -v "$(pwd):/workspace" armlimited/arm-mcp:latest
```
This configuration is stored in `~/.claude.json` and is accessible from any project directory.
You can choose other scopes (local or project) as described in the Docker section above.
Expand All @@ -254,7 +252,7 @@ finch pull armlimited/arm-mcp:latest
To make the Arm MCP Server available across all your projects (user scope):

```console
claude mcp add --scope user --transport stdio arm-mcp -- finch run --rm -i --pull=always -v "$(pwd):/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:latest
claude mcp add --scope user --transport stdio arm-mcp -- finch run --rm -i --pull=always -v "$(pwd):/workspace" armlimited/arm-mcp:latest
```
This configuration is stored in `~/.claude.json` and is accessible from any project directory.
You can choose other scopes (local or project) as described in the Docker section above.
Expand All @@ -272,7 +270,7 @@ docker pull armlimited/arm-mcp:latest
To make the Arm MCP Server available across all your projects (user scope):

```console
claude mcp add --scope user --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/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:latest
claude mcp add --scope user --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/workspace" armlimited/arm-mcp:latest
```
This configuration is stored in `~/.claude.json` and is accessible from any project directory.
You can choose other scopes (local or project) as described in the Docker section above.
Expand All @@ -290,7 +288,7 @@ docker pull armlimited/arm-mcp:latest
To make the Arm MCP Server available across all your projects (user scope):

```console
claude mcp add --scope user --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/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:latest
claude mcp add --scope user --transport stdio arm-mcp -- docker run --rm -i --pull=always -v "$(pwd):/workspace" armlimited/arm-mcp:latest
```
This configuration is stored in `~/.claude.json` and is accessible from any project directory.
You can choose other scopes (local or project) as described in the Docker section above.
Expand Down
16 changes: 1 addition & 15 deletions content/install-guides/codex-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,6 @@ args = [
"--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:latest"
]
startup_timeout_sec = 60
Expand All @@ -228,11 +224,9 @@ The section must be named `mcp_servers` with an underscore. Using `mcp-servers`
You can also add the Arm MCP server from the Codex CLI, after starting `codex` run:

```bash
codex mcp add arm-mcp -- sh -lc 'docker run --rm -i --pull=always -v "$PWD:/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:latest'
codex mcp add arm-mcp -- sh -lc 'docker run --rm -i --pull=always -v "$PWD:/workspace" armlimited/arm-mcp:latest'
```

To enable Arm Performix features through the Arm MCP Server, replace `/path/to/your/ssh/private_key` and `/path/to/your/ssh/known_hosts` with the SSH private key and `known_hosts` file used for your target device.

### Optional: Use a Docker replacement containerization tool

You can use other containerization tools besides Docker that are free and don't require licenses, such as Podman, Finch, Colima, and Rancher Desktop. Choose one of the following options and use its CLI in place of `docker`.
Expand All @@ -256,8 +250,6 @@ args = [
"-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:latest"
]
startup_timeout_sec = 60
Expand All @@ -281,8 +273,6 @@ args = [
"-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:latest"
]
startup_timeout_sec = 60
Expand All @@ -308,8 +298,6 @@ args = [
"-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:latest"
]
startup_timeout_sec = 60
Expand All @@ -335,8 +323,6 @@ args = [
"-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:latest"
]
startup_timeout_sec = 60
Expand Down
17 changes: 1 addition & 16 deletions content/install-guides/gemini.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,10 +370,6 @@ Make sure to use a `,` at the end of each object that is not the last one. For e
"--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:latest"
],
"env": {},
Expand All @@ -385,8 +381,6 @@ Make sure to use a `,` at the end of each object that is not the last one. For e

This configuration tells Gemini CLI to connect to the Arm MCP server running in the Docker container.

To enable Arm Performix features through the Arm MCP Server, replace `/path/to/your/ssh/private_key` and `/path/to/your/ssh/known_hosts` with the SSH private key and `known_hosts` file used for your target device.

### Optional: Use a Docker replacement containerization tool

You can use other containerization tools besides Docker that are free and do not require licenses, such as Podman, Finch, Colima, and Rancher Desktop. Choose one of the options below and use its CLI in place of `docker`.
Expand Down Expand Up @@ -417,8 +411,6 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file
"-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:latest"
],
"env": {},
Expand Down Expand Up @@ -453,8 +445,6 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file
"-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:latest"
],
"env": {},
Expand Down Expand Up @@ -491,8 +481,6 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file
"-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:latest"
],
"env": {},
Expand Down Expand Up @@ -529,8 +517,6 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file
"-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:latest"
],
"env": {},
Expand Down Expand Up @@ -567,14 +553,13 @@ The Arm MCP server tools are listed in the output:
```output
Configured MCP servers:

🟢 arm_mcp_server - Ready (6 tools)
🟢 arm_mcp_server - Ready (5 tools)
Tools:
- check_image
- knowledge_base_search
- mca
- migrate_ease_scan
- skopeo
- sysreport_instructions
```

### Use Arm prompt files with the MCP Server
Expand Down
18 changes: 0 additions & 18 deletions content/install-guides/github-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,10 +248,6 @@ Create an `mcp.json` file in the `.vscode` directory with the following configur
"--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:latest"
]
}
Expand All @@ -278,10 +274,6 @@ Add the following configuration to the user-level `mcp.json` file:
"--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:latest"
]
}
Expand All @@ -291,8 +283,6 @@ Add the following configuration to the user-level `mcp.json` file:

After saving your `mcp.json` file, a **Start** button appears at the top of the servers list. Select this button to start the Arm MCP Server.

To enable Arm Performix features through the Arm MCP Server, replace `/path/to/your/ssh/private_key` and `/path/to/your/ssh/known_hosts` with the SSH private key and `known_hosts` file used for your target device.

## Optional: Use a Docker replacement containerization tool

You can use other containerization tools besides Docker that are free and do not require licenses, such as Podman, Finch, Colima, and Rancher Desktop. Choose one of the options below and use its CLI in place of docker.
Expand All @@ -319,8 +309,6 @@ Add the following configuration to the user-level `mcp.json` file:
"-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:latest"
]
}
Expand Down Expand Up @@ -351,8 +339,6 @@ Add the following configuration to the user-level `mcp.json` file:
"-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:latest"
]
}
Expand Down Expand Up @@ -384,8 +370,6 @@ Add the following configuration to the user-level `mcp.json` file:
"-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:latest"
]
}
Expand Down Expand Up @@ -417,8 +401,6 @@ Add the following configuration to the user-level `mcp.json` file:
"-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:latest"
]
}
Expand Down
Loading
Loading