Periphery

Provides a local MCP server that wraps the Periphery CLI to audit Swift code and detect unused code in iOS and macOS projects.

typescript

1

GitHub Stars

typescript

Language

4 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "zyntx-lab-periphery-mcp-server": {
      "command": "/opt/homebrew/bin/periphery-mcp-server",
      "args": [],
      "env": {
        "CLAUDE_CONFIG_PATH": "/Users/you/Library/Application Support/Claude/claude_desktop_config.json"
      }
    }
  }
}

You run a local MCP server that wraps the Periphery CLI to help you audit Swift code and identify unused code in iOS and macOS projects. This server exposes a set of tools you can call from MCP clients to analyze projects, scan configurations, and receive structured results suitable for automated interpretation.

How to use

You connect to this MCP server from an MCP-compatible client. Use the provided tools to perform scans, verify Periphery installation, obtain version information, or analyze specific code aspects. The server's outputs are returned in structured JSON, making it easy for automated workflows and AI assistants to interpret.

How to install

Prerequisites you need before installation include macOS 13.0 or later and Swift 6.0 or later. Periphery should already be installed on your system.

Option 1: Install via Homebrew (recommended)

brew tap zyntx-lab/tap
brew install periphery-mcp-server

Option 2: Install from GitHub Releases

curl -L https://github.com/zyntx-lab/periphery-mcp-server/releases/download/v1.0.0/periphery-mcp-server \
  -o /usr/local/bin/periphery-mcp-server
chmod +x /usr/local/bin/periphery-mcp-server

Option 3: Build from Source

git clone https://github.com/zyntx-lab/periphery-mcp-server.git
cd periphery-mcp-server
swift build -c release
sudo cp .build/release/periphery-mcp-server /usr/local/bin/
sudo chmod +x /usr/local/bin/periphery-mcp-server

Option 4: Install from MCP Registry

Additional sections

Configuration for client applications and initial verification steps are provided to help you get up and running quickly. If you use a graphical editor or IDE integrations, ensure the MCP client can locate the local server binary and understands the expected tool names.

Troubleshooting and common issues are covered to guide you through installation verification, server startup, and diagnosing connectivity problems with MCP Inspector and client editors.

Configuration

Claude Desktop can connect to the local Periphery MCP server by configuring the MCP server entry with the appropriate command path. Use one of the following configurations depending on how you installed the server.

Troubleshooting

If the server does not appear in your MCP client or you encounter connection errors, verify the binary path, restart the client, and inspect logs for errors. Ensure Periphery is installed and accessible from your shell, and that the server process remains running when the client attempts to connect.

Notes

This server offers a CLI-based approach to Periphery for stability and compatibility. It allows clients to request analysis results in a structured format suitable for automation and AI interpretation.

Available tools

check_periphery_installed

Verify that the Periphery CLI is installed and accessible.

get_periphery_version

Return the installed Periphery version.

scan_project

Run a basic Periphery scan on a project, returning findings and a summary.

scan_with_config

Run Periphery scan using a YAML configuration file.

analyze_unused_imports

Detect unused imports within the project.

find_redundant_public

Identify public declarations that could be internal.

scan_with_options

Advanced scanning with custom Periphery flags and options.