diff --git a/README.md b/README.md index 59452f071e68..d78cbc0e7791 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,17 @@ docker pull us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:$VERSION +
+Homebrew + +To install Toolbox using Homebrew on macOS or Linux: + +```sh +brew install mcp-toolbox +``` + +
+
Compile from source @@ -157,6 +168,14 @@ execute `toolbox` to start the server: > [!NOTE] > Toolbox enables dynamic reloading by default. To disable, use the `--disable-reload` flag. +#### Homebrew Users + +If you installed Toolbox using Homebrew, the `toolbox` binary is available in your system path. You can start the server with the same command: + +```sh +toolbox --tools-file "tools.yaml" +``` + You can use `toolbox help` for a full list of flags! To stop the server, send a terminate signal (`ctrl+c` on most platforms). diff --git a/docs/en/getting-started/introduction/_index.md b/docs/en/getting-started/introduction/_index.md index fb98b6cd9665..7e6bfacc43a8 100644 --- a/docs/en/getting-started/introduction/_index.md +++ b/docs/en/getting-started/introduction/_index.md @@ -101,6 +101,13 @@ export VERSION=0.10.0 docker pull us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:$VERSION ``` +{{% /tab %}} +{{% tab header="Homebrew" lang="en" %}} +To install Toolbox using Homebrew on macOS or Linux: + +```sh +brew install mcp-toolbox +``` {{% /tab %}} {{% tab header="Compile from source" lang="en" %}} @@ -127,6 +134,14 @@ execute `toolbox` to start the server: Toolbox enables dynamic reloading by default. To disable, use the `--disable-reload` flag. {{< /notice >}} +#### Homebrew Users + +If you installed Toolbox using Homebrew, the `toolbox` binary is available in your system path. You can start the server with the same command: + +```sh +toolbox --tools-file "tools.yaml" +``` + You can use `toolbox help` for a full list of flags! To stop the server, send a terminate signal (`ctrl+c` on most platforms).