diff --git a/content/install-guides/claude-code.md b/content/install-guides/claude-code.md index 19a33be08f..4931a9eaff 100644 --- a/content/install-guides/claude-code.md +++ b/content/install-guides/claude-code.md @@ -220,6 +220,82 @@ claude mcp add --transport stdio arm-mcp -- docker run --rm -i --pull=always -v 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`. + +{{< 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" -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. + {{< /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" -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. + {{< /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" -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. + {{< /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" -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. + {{< /tab >}} +{{< /tabpane-normal >}} + + ## Verify the Arm MCP Server is working List configured MCP servers: diff --git a/content/install-guides/codex-cli.md b/content/install-guides/codex-cli.md index 7e0ec464b3..9075a7cb83 100644 --- a/content/install-guides/codex-cli.md +++ b/content/install-guides/codex-cli.md @@ -232,6 +232,117 @@ codex mcp add arm-mcp -- sh -lc 'docker run --rm -i --pull=always -v "$PWD:/work 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`. + +{{< 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", + "--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 +``` + {{< /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", + "--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 +``` + {{< /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", + "--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 +``` + {{< /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", + "--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 +``` + {{< /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 8c48090672..470fc8f80d 100644 --- a/content/install-guides/gemini.md +++ b/content/install-guides/gemini.md @@ -379,6 +379,161 @@ This configuration tells Gemini CLI to connect to the Arm MCP server running in 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`. + +{{< 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", + "--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": {}, + "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", + "--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": {}, + "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", + "--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": {}, + "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", + "--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": {}, + "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 82b8d8dd11..b509fbb8df 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 @@ -295,6 +291,142 @@ After saving your `mcp.json` file, a **Start** button appears at the top of the 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. + +{{< 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 `mcp.json` file: +```json +{ + "servers": { + "arm-mcp": { + "type": "stdio", + "command": "podman", + "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: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/) + +Pull the Arm MCP Server image: +```console +finch pull armlimited/arm-mcp:latest +``` + +Add the following configuration to the user-level `mcp.json` file: +```json +{ + "servers": { + "arm-mcp": { + "type": "stdio", + "command": "finch", + "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: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) + +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 `mcp.json` file: +```json +{ + "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: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/) + +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 `mcp.json` file: +```json +{ + "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: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? To analyze code in your workspace, mount your local directory to the MCP server's `/workspace` folder using a volume mount. diff --git a/content/install-guides/kiro-cli.md b/content/install-guides/kiro-cli.md index 898f508cea..58f2d4d1ee 100644 --- a/content/install-guides/kiro-cli.md +++ b/content/install-guides/kiro-cli.md @@ -253,6 +253,141 @@ Replace the path `/path/to/your/workspace` with the path to your local codebase: 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`. + +{{< 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", + "--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": {}, + "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", + "--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": {}, + "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", + "--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": {}, + "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", + "--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": {}, + "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/)