From ceeaeffc51fb6a5faf572af8942aed583e357007 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Fri, 18 Jul 2025 15:27:11 +0100 Subject: [PATCH] docs: add Homebrew's MCP server documentation. Provide some basic instructions on how to use and configure it. --- docs/MCP-Server.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 1 + 2 files changed, 79 insertions(+) create mode 100644 docs/MCP-Server.md diff --git a/docs/MCP-Server.md b/docs/MCP-Server.md new file mode 100644 index 0000000000..8487495a6c --- /dev/null +++ b/docs/MCP-Server.md @@ -0,0 +1,78 @@ +--- +last_review_date: "2025-07-18" +--- + +# Homebrew's MCP Server + +Homebrew's MCP Server is the official MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) server for Homebrew. + +You don't need to do anything to install it. +It's provided by default with Homebrew through the `brew mcp-server` command. + +## Usage + +Run `brew mcp-server` to launch the Homebrew MCP Server. + +```bash +$ brew mcp-server +==> Started Homebrew MCP server... +``` + +Press Ctrl-D or Ctrl-C to terminate it. + +## Configuration + +### Example configuration for [Cursor](https://www.cursor.com/) + +```json +{ + "mcpServers": { + "Homebrew": { + "command": "brew mcp-server" + } + } +} +``` + +### Example configuration for [VSCode](https://code.visualstudio.com/) + +```json +{ + "mcp": { + "servers": { + "Homebrew": { + "type": "stdio", + "command": "brew", + "args": ["mcp-server"] + } + } + } +} +``` + +### Example configuration for [Zed](https://github.com/zed-industries/zed) + +```json +{ + "context_servers": { + "Homebrew": { + "command": { + "path": "brew", + "args": ["mcp-server"] + } + } + } +} +``` + +### Example configuration for [Claude Desktop](https://claude.ai/download) + +```json +{ + "mcpServers": { + "Homebrew": { + "command": "brew mcp-server" + } + } +} +``` diff --git a/docs/index.md b/docs/index.md index 58eaa29bd7..038c9691a8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,6 +16,7 @@ last_review_date: "2025-02-08" - [`brew` Shell Completion](Shell-Completion.md) - [Homebrew on Linux](Homebrew-on-Linux.md) - [Homebrew Bundle, `brew bundle` and `Brewfile`](Brew-Bundle-and-Brewfile.md) +- [Homebrew MCP Server](MCP-Server.md) - [Bottles (binary packages)](Bottles.md) - [Taps (third-party repositories)](Taps.md)