From f4daecd3da67701f0506179b58c55cc70dffa204 Mon Sep 17 00:00:00 2001 From: Ivy Evans Date: Thu, 28 Aug 2025 11:22:10 -0700 Subject: [PATCH] docs: improve MCP server description Removes tools table and expand on the first section with details about what it can do. --- docs/MCP-Server.md | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/docs/MCP-Server.md b/docs/MCP-Server.md index cd4ef630ae..a391e12cd8 100644 --- a/docs/MCP-Server.md +++ b/docs/MCP-Server.md @@ -4,7 +4,7 @@ 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. +Homebrew's MCP Server is the official MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) server for Homebrew, enabling AI assistants like Cursor to interact with Homebrew directly, providing tools for package management, system diagnostics, and development workflows. It exposes common operations like package search/lookup, installation and removal, system updates, diagnostics, and development tools so AI assistants can help maintain your system and develop new formulas. You don't need to do anything to install it. It's provided by default with Homebrew through the `brew mcp-server` command. @@ -77,23 +77,3 @@ Press Ctrl-D or Ctrl-C to terminate it. } ``` -## 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. |