Skip to content

chore: update Docker instructions #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 26, 2025
Merged
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
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ access to Honeybadger's API through the MCP protocol.

## Installation

First, clone the repo and build the Docker image:
First, pull the Docker image:

```bash
git clone https://github.com/honeybadger-io/honeybadger-mcp-server.git
cd honeybadger-mcp-server
docker build -t honeybadger-mcp-server .
docker pull ghcr.io/honeybadger-io/honeybadger-mcp-server:latest
```

Then, configure your MCP client(s). You can find your personal auth token under the "Authentication" tab in your [Honeybadger User settings](https://app.honeybadger.io/users/edit).
Expand All @@ -28,7 +26,7 @@ Then, configure your MCP client(s). You can find your personal auth token under
"--rm",
"-e",
"HONEYBADGER_PERSONAL_AUTH_TOKEN",
"honeybadger-mcp-server"
"ghcr.io/honeybadger-io/honeybadger-mcp-server"
],
"env": {
"HONEYBADGER_PERSONAL_AUTH_TOKEN": "your personal auth token"
Expand Down Expand Up @@ -62,7 +60,7 @@ For Cursor, put this config in [`~/.cursor/mcp.json`](https://docs.cursor.com/co
"--rm",
"-e",
"HONEYBADGER_PERSONAL_AUTH_TOKEN",
"honeybadger-mcp-server"
"ghcr.io/honeybadger-io/honeybadger-mcp-server"
],
"env": {
"HONEYBADGER_PERSONAL_AUTH_TOKEN": "${input:honeybadger_auth_token}"
Expand Down Expand Up @@ -91,7 +89,7 @@ You can add the following directly to your Zed settings file (`~/.config/zed/set
"--rm",
"-e",
"HONEYBADGER_PERSONAL_AUTH_TOKEN",
"honeybadger-mcp-server"
"ghcr.io/honeybadger-io/honeybadger-mcp-server"
],
"env": {
"HONEYBADGER_PERSONAL_AUTH_TOKEN": "your personal auth token"
Expand All @@ -103,11 +101,31 @@ You can add the following directly to your Zed settings file (`~/.config/zed/set
}
```

### Building Docker locally

To build the Docker image and run it locally:

```bash
git clone git@github.com:honeybadger-io/honeybadger-mcp-server.git
cd honeybadger-mcp-server
docker build -t honeybadger-mcp-server .
```

Then you can replace "ghcr.io/honeybadger-io/honeybadger-mcp-server" with
"honeybadger-mcp-server" in any of the configs above. Or you can run the image
directly:

```bash
docker run -i --rm -e HONEYBADGER_PERSONAL_ACCESS_TOKEN honeybadger-mcp-server
```

### Building from source

If you don't have Docker, you can build the server from source:

```bash
git clone git@github.com:honeybadger-io/honeybadger-mcp-server.git
cd honeybadger-mcp-server
go build -o honeybadger-mcp-server ./cmd/honeybadger-mcp-server
```

Expand Down
Loading