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
76 changes: 75 additions & 1 deletion content/install-guides/claude-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.

103 changes: 103 additions & 0 deletions content/install-guides/codex-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
147 changes: 147 additions & 0 deletions content/install-guides/gemini.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading
Loading