brew/docs/MCP-Server.md
Ivy Evans 7358c96dbb Document available MCP server tools
I spotted this new feature on the Homebrew website but I didn't see any
details about what it could do! Very excited to try it out!

This commit documents each of the available tools, following the details
in `Library/Homebrew/mcp_server.rb`.
2025-08-27 10:51:17 -07:00

2.9 KiB

last_review_date
last_review_date
2025-07-18

Homebrew's MCP Server

Homebrew's MCP Server is the official MCP (Model Context Protocol) 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.

$ brew mcp-server
==> Started Homebrew MCP server...

Press Ctrl-D or Ctrl-C to terminate it.

Configuration

Example configuration for Cursor

{
  "mcpServers": {
    "Homebrew": {
      "command": "brew mcp-server"
    }
  }
}

Example configuration for VSCode

{
  "mcp": {
    "servers": {
      "Homebrew": {
        "type": "stdio",
        "command": "brew",
        "args": ["mcp-server"]
      }
    }
  }
}

Example configuration for Zed

{
  "context_servers": {
    "Homebrew": {
      "command": {
        "path": "brew",
        "args": ["mcp-server"]
      }
    }
  }
}

Example configuration for Claude Desktop

{
  "mcpServers": {
    "Homebrew": {
      "command": "brew mcp-server"
    }
  }
}

Available Tools

The Homebrew MCP Server provides the following tools:

Tool Description
search Perform a substring search of cask tokens and formula names. If text is flanked by slashes, it is interpreted as a regular expression.
info Display brief statistics for your Homebrew installation. If a formula or cask is provided, show summary of information about it.
install Install a formula or cask.
update Fetch the newest version of Homebrew and all formulae from GitHub using git and perform any necessary migrations.
upgrade Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally installed with. If cask or formula are specified, upgrade only the given cask or formula kegs (unless they are pinned).
uninstall Uninstall a formula or cask.
list List all installed formulae and casks. If formula is provided, summarise the paths within its current keg. If cask is provided, list its artifacts.
config Show Homebrew and system configuration info useful for debugging. If you file a bug report, you will be required to provide this information.
doctor Check your system for potential problems. Will exit with a non-zero status if any potential problems are found.
typecheck Check for typechecking errors using Sorbet.
style Check formulae or files for conformance to Homebrew style guidelines.
tests Run Homebrew's unit and integration tests.
commands Show lists of built-in and external commands.
help Outputs the usage instructions for a brew command.