Skip to content

docs: add homebrew installation notes for mcp-publisher #384

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.

Sign up for GitHub

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 3 commits into from
Sep 9, 2025
Merged

docs: add homebrew installation notes for mcp-publisher #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4787c68
docs: add homebrew installation notes for mcp-publisher
chenrui333 Sep 9, 2025
10d095c
Merge remote-tracking branch 'origin/main' into update-homebrew-insta…
domdomegg Sep 9, 2025
fcc4d0c
Move install sections into details blocks
domdomegg Sep 9, 2025
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
33 changes: 25 additions & 8 deletions docs/guides/publishing/publish-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,30 @@ By the end of this tutorial, you'll have:

## Step 1: Install the Publisher CLI

**macOS/Linux/WSL:**
<details>
<summary><strong>🍺 macOS/Linux/WSL: With Homebrew (recommended)</strong></summary>

Requires [Homebrew](https://brew.sh):

```bash
curl -L "https://github.com/modelcontextprotocol/registry/releases/download/v1.0.0/mcp-publisher_1.0.0_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz mcp-publisher && sudo mv mcp-publisher /usr/local/bin/
brew install mcp-publisher
```

**Windows (PowerShell):**
</details>

```powershell
$arch = if ([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture -eq "Arm64") { "arm64" } else { "amd64" }; Invoke-WebRequest -Uri "https://github.com/modelcontextprotocol/registry/releases/download/v1.0.0/mcp-publisher_1.0.0_windows_$arch.tar.gz" -OutFile "mcp-publisher.tar.gz"; tar xf mcp-publisher.tar.gz mcp-publisher.exe; rm mcp-publisher.tar.gz
# Move mcp-publisher.exe to a directory in your PATH
<details>
<summary><strong>⬇️ macOS/Linux/WSL: Pre-built binaries</strong></summary>

```bash
curl -L "https://github.com/modelcontextprotocol/registry/releases/download/v1.0.0/mcp-publisher_1.0.0_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz mcp-publisher && sudo mv mcp-publisher /usr/local/bin/
```

</details>

<details>
<summary>Alternative: Build from Source</summary>
<summary><strong>🏗️ macOS/Linux/WSL: From source</strong></summary>

If you prefer to build from source (requires Git, Make and Go 1.24+):
Requires Git, Make and Go 1.24+:

```bash
# Clone the registry repository
Expand All @@ -47,6 +54,16 @@ export PATH=$PATH:$(pwd)/bin

</details>

<details>
<summary><strong>🪟 Windows PowerShell: Pre-built binaries</strong></summary>

```powershell
$arch = if ([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture -eq "Arm64") { "arm64" } else { "amd64" }; Invoke-WebRequest -Uri "https://github.com/modelcontextprotocol/registry/releases/download/v1.0.0/mcp-publisher_1.0.0_windows_$arch.tar.gz" -OutFile "mcp-publisher.tar.gz"; tar xf mcp-publisher.tar.gz mcp-publisher.exe; rm mcp-publisher.tar.gz
# Move mcp-publisher.exe to a directory in your PATH
```

</details>

## Step 2: Initialize Your server.json

Navigate to your server's directory and create a template:
Expand Down
9 changes: 2 additions & 7 deletions docs/reference/cli/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,10 @@ See the [publishing guide](../../guides/publishing/publish-server.md) for a walk

## Installation

<!-- TODO: update once #358 solved -->
Install via Homebrew (macOS/Linux):

```bash
# Build from source (from repository root)
make publisher
# Binary created at ./cmd/publisher/bin/mcp-publisher

# Install globally (optional)
cp ./cmd/publisher/bin/mcp-publisher /usr/local/bin/
$ brew install mcp-publisher
```

## Global Options
Expand Down
Loading