From 20a16fd367695d5cfbf93a23fc77bf1a6b3e0115 Mon Sep 17 00:00:00 2001 From: Jaidev Singh Chadha Date: Mon, 27 Apr 2026 15:12:39 -0700 Subject: [PATCH 1/6] Add Podman alias guidance for MCP setup --- content/install-guides/github-copilot.md | 50 ++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/content/install-guides/github-copilot.md b/content/install-guides/github-copilot.md index 682f293966..3721dcc20a 100644 --- a/content/install-guides/github-copilot.md +++ b/content/install-guides/github-copilot.md @@ -281,6 +281,56 @@ 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. +## Use Podman as a Docker drop-in replacement + +Podman's CLI is command-compatible with Docker. By creating a `docker` alias you can run existing Docker commands, including those in the Arm MCP Server docs, without changes. + +###### **macOS / Linux (bash / zsh)** + +Add to your `~/.bashrc`, `~/.zshrc`, or `~/.profile`: + +```bash +alias docker=podman +``` + +Reload your shell: + +```bash +source ~/.zshrc # or ~/.bashrc +``` + +###### **Windows (PowerShell)** + +Add to your PowerShell profile (`$PROFILE`): + +```powershell +Set-Alias -Name docker -Value podman +``` + +Reload: + +```powershell +. $PROFILE +``` + +###### **Verify the alias** + +After setting the alias, all Docker commands are transparently handled by Podman: + +```console +docker info # -> podman info +docker pull armlimited/arm-mcp:latest # -> podman pull ... +docker run -i --rm armlimited/arm-mcp:latest # -> podman run ... +``` + +{{% notice Note %}} +Remember to change your `mcp.json` from `"command": "docker"` to `"command": "podman"`. If you still run into issues, set `"command"` to the full path of the Podman binary. +{{% /notice %}} + +{{% notice Note %}} +You can also use other container platforms like [Finch](https://runfinch.com/). We recommend aliasing `docker` to `finch` (or your chosen platform) so the commands remain the same, and update `"command"` in `mcp.json` to that platform. +{{% /notice %}} + ## How do I analyze a local codebase with the Arm MCP Server? To analyze code in your workspace, mount your local directory to the MCP server's `/workspace` folder using a volume mount. From 8f987cd23dd8881682278e4247c01e54008e816a Mon Sep 17 00:00:00 2001 From: Jaidev Singh Chadha Date: Mon, 27 Apr 2026 15:34:20 -0700 Subject: [PATCH 2/6] Remove test metadata from Copilot guide --- content/install-guides/github-copilot.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/content/install-guides/github-copilot.md b/content/install-guides/github-copilot.md index 3721dcc20a..59bc607fd7 100644 --- a/content/install-guides/github-copilot.md +++ b/content/install-guides/github-copilot.md @@ -5,10 +5,6 @@ author: Pareena Verma minutes_to_complete: 10 official_docs: https://docs.github.com/en/copilot -test_maintenance: true -test_images: -- ubuntu:latest - layout: installtoolsall multi_install: false multitool_install_part: false From 1f50baf4c4cc7563d4b2f3813ab85764673391ec Mon Sep 17 00:00:00 2001 From: Jaidev Singh Chadha Date: Wed, 29 Apr 2026 14:19:59 -0700 Subject: [PATCH 3/6] Update GitHub Copilot install guide --- content/install-guides/github-copilot.md | 136 +++++++++++++++++------ 1 file changed, 105 insertions(+), 31 deletions(-) diff --git a/content/install-guides/github-copilot.md b/content/install-guides/github-copilot.md index 59bc607fd7..4b0ff82a9a 100644 --- a/content/install-guides/github-copilot.md +++ b/content/install-guides/github-copilot.md @@ -277,55 +277,129 @@ 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. -## Use Podman as a Docker drop-in replacement +## Use a Docker replacement containerization tool -Podman's CLI is command-compatible with Docker. By creating a `docker` alias you can run existing Docker commands, including those in the Arm MCP Server docs, without changes. +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. -###### **macOS / Linux (bash / zsh)** +{{< tabpane-normal >}} + {{< tab header="Podman" >}} +Install: [Podman](https://podman.io/docs/installation) -Add to your `~/.bashrc`, `~/.zshrc`, or `~/.profile`: - -```bash -alias docker=podman +Pull the Arm MCP Server image: +```console +podman pull armlimited/arm-mcp:latest ``` -Reload your shell: - -```bash -source ~/.zshrc # or ~/.bashrc +Add the following configuration to the user-level `mcp.json` file: +```json +{ + "servers": { + "arm-mcp": { + "type": "stdio", + "command": "podman", + "args": [ + "run", + "--rm", + "-i", + "-v", "/path/to/your/codebase:/workspace", + "armlimited/arm-mcp:latest" + ] + } + } +} ``` +If you still run into issues, set `"command"` to the full path of the Podman binary. +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. + {{< /tab >}} + {{< tab header="Finch" >}} +Install: [Finch](https://runfinch.com/docs/getting-started/installation/) -###### **Windows (PowerShell)** - -Add to your PowerShell profile (`$PROFILE`): +Pull the Arm MCP Server image: +```console +finch pull armlimited/arm-mcp:latest +``` -```powershell -Set-Alias -Name docker -Value podman +Add the following configuration to the user-level `mcp.json` file: +```json +{ + "servers": { + "arm-mcp": { + "type": "stdio", + "command": "finch", + "args": [ + "run", + "--rm", + "-i", + "-v", "/path/to/your/codebase:/workspace", + "armlimited/arm-mcp:latest" + ] + } + } +} ``` +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. + {{< /tab >}} + {{< tab header="Colima" >}} +Install: [Colima](https://github.com/abiosoft/colima#installation) -Reload: +Colima provides a Docker-compatible CLI via Docker contexts. -```powershell -. $PROFILE +Pull the Arm MCP Server image: +```console +docker pull armlimited/arm-mcp:latest ``` -###### **Verify the alias** +Add the following configuration to the user-level `mcp.json` file: +```json +{ + "servers": { + "arm-mcp": { + "type": "stdio", + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "-v", "/path/to/your/codebase:/workspace", + "armlimited/arm-mcp:latest" + ] + } + } +} +``` +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. + {{< /tab >}} + {{< tab header="Rancher Desktop" >}} +Install: [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/) -After setting the alias, all Docker commands are transparently handled by Podman: +Rancher Desktop uses the Docker container engine via Morby. +Pull the Arm MCP Server image: ```console -docker info # -> podman info -docker pull armlimited/arm-mcp:latest # -> podman pull ... -docker run -i --rm armlimited/arm-mcp:latest # -> podman run ... +docker pull armlimited/arm-mcp:latest ``` -{{% notice Note %}} -Remember to change your `mcp.json` from `"command": "docker"` to `"command": "podman"`. If you still run into issues, set `"command"` to the full path of the Podman binary. -{{% /notice %}} - -{{% notice Note %}} -You can also use other container platforms like [Finch](https://runfinch.com/). We recommend aliasing `docker` to `finch` (or your chosen platform) so the commands remain the same, and update `"command"` in `mcp.json` to that platform. -{{% /notice %}} +Add the following configuration to the user-level `mcp.json` file: +```json +{ + "servers": { + "arm-mcp": { + "type": "stdio", + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "-v", "/path/to/your/codebase:/workspace", + "armlimited/arm-mcp:latest" + ] + } + } +} +``` +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. + {{< /tab >}} +{{< /tabpane-normal >}} ## How do I analyze a local codebase with the Arm MCP Server? From 65220a63e2775b9dab13921b14089ac7727f56d6 Mon Sep 17 00:00:00 2001 From: Jaidev Singh Chadha Date: Wed, 29 Apr 2026 16:02:05 -0700 Subject: [PATCH 4/6] adding instructions for other agents. --- content/install-guides/codex-cli.md | 103 ++++++++++++ content/install-guides/gemini.md | 147 ++++++++++++++++++ content/install-guides/github-copilot.md | 2 +- content/install-guides/kiro-cli.md | 127 +++++++++++++++ .../arm-mcp-server/1-overview.md | 1 + 5 files changed, 379 insertions(+), 1 deletion(-) diff --git a/content/install-guides/codex-cli.md b/content/install-guides/codex-cli.md index 2a10450e0f..0387a9768c 100644 --- a/content/install-guides/codex-cli.md +++ b/content/install-guides/codex-cli.md @@ -225,6 +225,109 @@ You can also add the Arm MCP server from the Codex CLI, after starting `codex` r codex mcp add arm-mcp -- sh -lc 'docker run --rm -i -v "$PWD:/workspace" --name arm-mcp armlimited/arm-mcp:latest' ``` +### 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`. + +{{< tabpane-normal >}} + {{< tab header="Podman" >}} +Install: [Podman](https://podman.io/docs/installation) + +Pull the Arm MCP Server image: +```console +podman pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.codex/config.toml` file: +```toml +[mcp_servers.arm-mcp] +command = "podman" +args = [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" +] +startup_timeout_sec = 60 +``` + {{< /tab >}} + {{< tab header="Finch" >}} +Install: [Finch](https://runfinch.com/docs/getting-started/installation/) + +Pull the Arm MCP Server image: +```console +finch pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.codex/config.toml` file: +```toml +[mcp_servers.arm-mcp] +command = "finch" +args = [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" +] +startup_timeout_sec = 60 +``` + {{< /tab >}} + {{< tab header="Colima" >}} +Install: [Colima](https://github.com/abiosoft/colima#installation) + +Colima provides a Docker-compatible CLI via Docker contexts. + +Pull the Arm MCP Server image: +```console +docker pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.codex/config.toml` file: +```toml +[mcp_servers.arm-mcp] +command = "docker" +args = [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" +] +startup_timeout_sec = 60 +``` + {{< /tab >}} + {{< tab header="Rancher Desktop" >}} +Install: [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/) + +Rancher Desktop uses the Docker container engine via Morby. + +Pull the Arm MCP Server image: +```console +docker pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.codex/config.toml` file: +```toml +[mcp_servers.arm-mcp] +command = "docker" +args = [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" +] +startup_timeout_sec = 60 +``` + {{< /tab >}} +{{< /tabpane-normal >}} + ### How do I verify the Arm MCP server is working? Start Codex CLI and list the tools from the MCP server to verify it is working: diff --git a/content/install-guides/gemini.md b/content/install-guides/gemini.md index 094c259530..0ed9881f73 100644 --- a/content/install-guides/gemini.md +++ b/content/install-guides/gemini.md @@ -372,6 +372,153 @@ You may have other objects already in the file so make sure to use a `,` at the This configuration tells Gemini CLI to connect to the Arm MCP server running in the Docker container. +### 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`. + +{{< tabpane-normal >}} + {{< tab header="Podman" >}} +Install: [Podman](https://podman.io/docs/installation) + +Pull the Arm MCP Server image: +```console +podman pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.gemini/settings.json` file: +```json +{ + "security": { + "auth": { + "selectedType": "oauth-personal" + } + }, + "mcpServers": { + "arm_mcp_server": { + "command": "podman", + "args": [ + "run", + "--rm", + "-i", + "-v", "$HOME/workspace:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} + {{< tab header="Finch" >}} +Install: [Finch](https://runfinch.com/docs/getting-started/installation/) + +Pull the Arm MCP Server image: +```console +finch pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.gemini/settings.json` file: +```json +{ + "security": { + "auth": { + "selectedType": "oauth-personal" + } + }, + "mcpServers": { + "arm_mcp_server": { + "command": "finch", + "args": [ + "run", + "--rm", + "-i", + "-v", "$HOME/workspace:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} + {{< tab header="Colima" >}} +Install: [Colima](https://github.com/abiosoft/colima#installation) + +Colima provides a Docker-compatible CLI via Docker contexts. + +Pull the Arm MCP Server image: +```console +docker pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.gemini/settings.json` file: +```json +{ + "security": { + "auth": { + "selectedType": "oauth-personal" + } + }, + "mcpServers": { + "arm_mcp_server": { + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "-v", "$HOME/workspace:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} + {{< tab header="Rancher Desktop" >}} +Install: [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/) + +Rancher Desktop uses the Docker container engine via Morby. + +Pull the Arm MCP Server image: +```console +docker pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.gemini/settings.json` file: +```json +{ + "security": { + "auth": { + "selectedType": "oauth-personal" + } + }, + "mcpServers": { + "arm_mcp_server": { + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "-v", "$HOME/workspace:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} +{{< /tabpane-normal >}} + ### How do I verify the Arm MCP server is working? Start the Gemini CLI and list the tools from the MCP server to verify it's working: diff --git a/content/install-guides/github-copilot.md b/content/install-guides/github-copilot.md index 4b0ff82a9a..7e66a46f6b 100644 --- a/content/install-guides/github-copilot.md +++ b/content/install-guides/github-copilot.md @@ -277,7 +277,7 @@ 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. -## Use a Docker replacement containerization tool +## 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. diff --git a/content/install-guides/kiro-cli.md b/content/install-guides/kiro-cli.md index 18507806d4..1233fe77d7 100644 --- a/content/install-guides/kiro-cli.md +++ b/content/install-guides/kiro-cli.md @@ -246,6 +246,133 @@ Replace the path `/Users/yourname01/yourlocalcodebase` with the path to your loc } ``` +### 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`. + +{{< tabpane-normal >}} + {{< tab header="Podman" >}} +Install: [Podman](https://podman.io/docs/installation) + +Pull the Arm MCP Server image: +```console +podman pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.kiro/settings/mcp.json` file: +```json +{ + "mcpServers": { + "arm_mcp_server": { + "command": "podman", + "args": [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} + {{< tab header="Finch" >}} +Install: [Finch](https://runfinch.com/docs/getting-started/installation/) + +Pull the Arm MCP Server image: +```console +finch pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.kiro/settings/mcp.json` file: +```json +{ + "mcpServers": { + "arm_mcp_server": { + "command": "finch", + "args": [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} + {{< tab header="Colima" >}} +Install: [Colima](https://github.com/abiosoft/colima#installation) + +Colima provides a Docker-compatible CLI via Docker contexts. + +Pull the Arm MCP Server image: +```console +docker pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.kiro/settings/mcp.json` file: +```json +{ + "mcpServers": { + "arm_mcp_server": { + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} + {{< tab header="Rancher Desktop" >}} +Install: [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/) + +Rancher Desktop uses the Docker container engine via Morby. + +Pull the Arm MCP Server image: +```console +docker pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `~/.kiro/settings/mcp.json` file: +```json +{ + "mcpServers": { + "arm_mcp_server": { + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "-v", "/Users/yourname01/yourlocalcodebase:/workspace", + "--name", "arm-mcp", + "armlimited/arm-mcp:latest" + ], + "env": {}, + "timeout": 60000 + } + } +} +``` + {{< /tab >}} +{{< /tabpane-normal >}} + ### How do I verify the Arm MCP server is working? Start Kiro CLI chat from your local shell and list the tools from the MCP server to verify it is working: diff --git a/content/learning-paths/servers-and-cloud-computing/arm-mcp-server/1-overview.md b/content/learning-paths/servers-and-cloud-computing/arm-mcp-server/1-overview.md index 408827dd2e..f2eae89046 100644 --- a/content/learning-paths/servers-and-cloud-computing/arm-mcp-server/1-overview.md +++ b/content/learning-paths/servers-and-cloud-computing/arm-mcp-server/1-overview.md @@ -90,6 +90,7 @@ To use the Arm MCP Server with an AI coding assistant, you need to configure the The required configuration steps vary by AI coding assistant. Refer to the installation guides below for step-by-step instructions on connecting the following AI coding assistants to the Arm MCP server: - [GitHub Copilot](/install-guides/github-copilot/) +- [Claude Code](/install-guides/claude-code/) - [Gemini CLI](/install-guides/gemini/) - [Kiro CLI](/install-guides/kiro-cli/) - [Codex CLI](/install-guides/codex-cli/) From 603d4c91f30401698e2b3346eb0baf1cb6e1a9b5 Mon Sep 17 00:00:00 2001 From: Jaidev Singh Chadha Date: Wed, 29 Apr 2026 16:32:06 -0700 Subject: [PATCH 5/6] Update Claude Code install guide --- content/install-guides/claude-code.md | 76 ++++++++++++++++++++++++++- 1 file changed, 75 insertions(+), 1 deletion(-) diff --git a/content/install-guides/claude-code.md b/content/install-guides/claude-code.md index 9fa5be4f64..b824944483 100644 --- a/content/install-guides/claude-code.md +++ b/content/install-guides/claude-code.md @@ -218,6 +218,81 @@ To analyze a different directory, modify the volume mount in the `docker run` co claude mcp add --transport stdio arm-mcp -- docker run --rm -i -v "/Users/username/myproject:/workspace" armlimited/arm-mcp:latest ``` +### 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`. + +{{< tabpane-normal >}} + {{< tab header="Podman" >}} +Install: [Podman](https://podman.io/docs/installation) + +Pull the Arm MCP Server image: +```console +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" 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. + {{< /tab >}} + {{< tab header="Finch" >}} +Install: [Finch](https://runfinch.com/docs/getting-started/installation/) + +Pull the Arm MCP Server image: +```console +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" 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. + {{< /tab >}} + {{< tab header="Colima" >}} +Install: [Colima](https://github.com/abiosoft/colima#installation) + +Colima provides a Docker-compatible CLI via Docker contexts. + +Pull the Arm MCP Server image: +```console +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" 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. + {{< /tab >}} + {{< tab header="Rancher Desktop" >}} +Install: [Rancher Desktop](https://docs.rancherdesktop.io/getting-started/installation/) + +Rancher Desktop uses the Docker container engine via Morby. + +Pull the Arm MCP Server image: +```console +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" 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. + {{< /tab >}} +{{< /tabpane-normal >}} + ## Verify the Arm MCP Server is working List configured MCP servers: @@ -297,4 +372,3 @@ If you encounter issues or have questions, reach out to mcpserver@arm.com. ## Custom prompts and workflows Create custom prompts for common tasks in your workflow. Refer to the [Claude Code documentation](https://code.claude.com/docs) for advanced configuration options. - From f754f91157a743f0c76559e02f70d7172c01bc73 Mon Sep 17 00:00:00 2001 From: Jaidev Singh Chadha Date: Fri, 1 May 2026 14:34:28 -0700 Subject: [PATCH 6/6] Align optional container configs with primary MCP mounts - Update Podman/Finch/Colima/Rancher optional configs across five install guides - Match primary install run arguments and volume mounts --- content/install-guides/claude-code.md | 8 ++++---- content/install-guides/codex-cli.md | 24 ++++++++++++++++-------- content/install-guides/gemini.md | 24 ++++++++++++++++-------- content/install-guides/github-copilot.md | 20 ++++++++++++++++---- content/install-guides/kiro-cli.md | 24 ++++++++++++++++-------- 5 files changed, 68 insertions(+), 32 deletions(-) diff --git a/content/install-guides/claude-code.md b/content/install-guides/claude-code.md index 193bd2b038..4931a9eaff 100644 --- a/content/install-guides/claude-code.md +++ b/content/install-guides/claude-code.md @@ -236,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" armlimited/arm-mcp:latest +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 ``` 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. @@ -252,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" armlimited/arm-mcp:latest +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 ``` 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. @@ -270,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" armlimited/arm-mcp:latest +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 ``` 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. @@ -288,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" armlimited/arm-mcp:latest +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 ``` 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. diff --git a/content/install-guides/codex-cli.md b/content/install-guides/codex-cli.md index a566078e2e..9075a7cb83 100644 --- a/content/install-guides/codex-cli.md +++ b/content/install-guides/codex-cli.md @@ -253,8 +253,10 @@ args = [ "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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 @@ -276,8 +278,10 @@ args = [ "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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 @@ -301,8 +305,10 @@ args = [ "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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 @@ -326,8 +332,10 @@ args = [ "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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 diff --git a/content/install-guides/gemini.md b/content/install-guides/gemini.md index 292859d513..470fc8f80d 100644 --- a/content/install-guides/gemini.md +++ b/content/install-guides/gemini.md @@ -407,8 +407,10 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file "run", "--rm", "-i", - "-v", "$HOME/workspace:/workspace", - "--name", "arm-mcp", + "--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": {}, @@ -441,8 +443,10 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file "run", "--rm", "-i", - "-v", "$HOME/workspace:/workspace", - "--name", "arm-mcp", + "--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": {}, @@ -477,8 +481,10 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file "run", "--rm", "-i", - "-v", "$HOME/workspace:/workspace", - "--name", "arm-mcp", + "--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": {}, @@ -513,8 +519,10 @@ Add the following configuration to the user-level `~/.gemini/settings.json` file "run", "--rm", "-i", - "-v", "$HOME/workspace:/workspace", - "--name", "arm-mcp", + "--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": {}, diff --git a/content/install-guides/github-copilot.md b/content/install-guides/github-copilot.md index 7c879829de..b509fbb8df 100644 --- a/content/install-guides/github-copilot.md +++ b/content/install-guides/github-copilot.md @@ -315,7 +315,10 @@ Add the following configuration to the user-level `mcp.json` file: "run", "--rm", "-i", - "-v", "/path/to/your/codebase:/workspace", + "--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" ] } @@ -344,7 +347,10 @@ Add the following configuration to the user-level `mcp.json` file: "run", "--rm", "-i", - "-v", "/path/to/your/codebase:/workspace", + "--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" ] } @@ -374,7 +380,10 @@ Add the following configuration to the user-level `mcp.json` file: "run", "--rm", "-i", - "-v", "/path/to/your/codebase:/workspace", + "--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" ] } @@ -404,7 +413,10 @@ Add the following configuration to the user-level `mcp.json` file: "run", "--rm", "-i", - "-v", "/path/to/your/codebase:/workspace", + "--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" ] } diff --git a/content/install-guides/kiro-cli.md b/content/install-guides/kiro-cli.md index f2008c825b..58f2d4d1ee 100644 --- a/content/install-guides/kiro-cli.md +++ b/content/install-guides/kiro-cli.md @@ -276,8 +276,10 @@ Add the following configuration to the user-level `~/.kiro/settings/mcp.json` fi "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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": {}, @@ -305,8 +307,10 @@ Add the following configuration to the user-level `~/.kiro/settings/mcp.json` fi "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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": {}, @@ -336,8 +340,10 @@ Add the following configuration to the user-level `~/.kiro/settings/mcp.json` fi "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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": {}, @@ -367,8 +373,10 @@ Add the following configuration to the user-level `~/.kiro/settings/mcp.json` fi "run", "--rm", "-i", - "-v", "/Users/yourname01/yourlocalcodebase:/workspace", - "--name", "arm-mcp", + "--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": {},