localwp-agent-tools

KO | EN

gitlite — search

#java #javascript #hacktoberfest #swift #nodejs #android #golang #go #ios #r #arduino #motion-detection

localwp-agent-tools

★ 39 Open GitHub ↗

A Local add-on that provides an MCP server, skills, and project context for AI-powered WordPress development. Works with Claude Code, Cursor, Windsurf, VS Code Copilot, and any MCP client.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# LocalWP Agent Tools

[![Support Level](https://img.shields.io/badge/support-active-green.svg)](https://raw.githubusercontent.com/10up/localwp-agent-tools/main/) [![CI](https://github.com/10up/localwp-agent-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/10up/localwp-agent-tools/actions/workflows/ci.yml) [![GPL-2.0-or-later License](https://img.shields.io/github/license/10up/localwp-agent-tools.svg)](https://github.com/10up/localwp-agent-tools/blob/main/LICENSE.md)

> A [Local](https://localwp.com/) add-on that provides an MCP server and project context for AI-powered WordPress development. Works with Claude Code, Cursor, Windsurf, VS Code Copilot, and any MCP client.

## What It Does

When you click "Enable" on a site in Local, the add-on:

1. **Registers the site with the MCP server** — a single HTTP server running in Local's main process that gives AI tools access to WP-CLI, error logs, configuration, and site management
2. **Writes MCP config** (`.mcp.json`, `.cursor/mcp.json`, etc.) — auto-configured with the correct HTTP endpoint for each agent
3. **Generates project context** (`CLAUDE.md`, `.cursorrules`, etc.) — site context including PHP/MySQL versions, active plugins, theme, and file structure
4. **Updates `.gitignore`** — so generated files aren't committed

Then open the site folder in your AI tool of choice and you're ready to go.

## Architecture

The MCP server runs as a single HTTP server inside Local's Electron main process — no separate Node.js processes per site. Each site gets its own endpoint:

```
http://localhost:{port}/sites/{siteId}/mcp
```

The server uses the MCP Streamable HTTP transport. The port is stable across restarts (persisted at `~/.local-agent-tools/port`, default 24842).

Sites remain registered even when stopped, so the MCP endpoint is always reachable. Tools that need running services (WP-CLI, database) return appropriate errors; file-based tools (config, logs, site info) work regardless. Config is refreshed on each tool call, so starting a site automatically makes database tools work without reconnecting.

## Supported Agents

| Agent           | MCP Config           | Context File                      |
| --------------- | -------------------- | --------------------------------- |
| Claude Code     | `.mcp.json`          | `CLAUDE.md`                       |
| Cursor          | `.cursor/mcp.json`   | `.cursorrules`                    |
| Windsurf        | `.windsurf/mcp.json` | `.windsurfrules`                  |
| VS Code Copilot | `.vscode/mcp.json`   | `.github/copilot-instructions.md` |

## MCP Tools (12 total)

| Category        | Tools               | Description                                                                                                |
| --------------- | ------------------- | ---------------------------------------------------------------------------------------------------------- |
| **WP-CLI**      | `wp_cli`            | Run any WP-CLI command (database queries, imports, exports, search-replace, plugin/theme management, etc.) |
| **Logs**        | `read_error_log`    | Read and parse the PHP error log                                                                           |
|                 | `read_access_log`   | Read the nginx access log                                                                                  |
|                 | `wp_debug_toggle`   | Enable/disable WP_DEBUG, WP_DEBUG_LOG, and SCRIPT_DEBUG                                                    |
| **Config**      | `read_wp_config`    | Parse wp-config.php constants and table prefix                                                             |
|                 | `edit_wp_config`    | Add or modify a wp-config.php constant (with backup)                                                       |
| **Site**        | `get_site_info`     | Paths, URLs, database config, PHP/WP versions, active plugins and theme                                    |
|                 | `site_health_check` | Database connectivity, file permissions, WP_DEBUG status, log sizes, PHP version                           |
| **Environment** | `site_start`        | Start a site's services (PHP, MySQL, web server)                                                           |
|                 | `site_stop`         | Stop a site's services                                                                                     |
|                 | `site_restart`      | Restart a site's services                                                                                  |
|                 | `site_status`       | Get current status of a site                                                                               |
|                 | `list_sites`        | List all Local sites with status                                                                           |

## Installation

### From Source

```bash
git clone <repo-url> agent-tools
cd agent-tools
npm install --legacy-peer-deps
npm run build
```

Copy the built add-on to Local's add-ons directory:

```bash
# macOS
cp -r . ~/Library/Application\ Support/Local/addons/agent-tools/

# Linux
cp -r . ~/.config/Local/addons/agent-tools/

# Windows (PowerShell)
Copy-Item -Recurse -Force . "$env:APPDATA\Local\addons\agent-tools"
```

Install production dependencies in the installed location and restart Local:

```bash
# macOS
cd ~/Library/Application\ Support/Local/addons/agent-tools/

# Linux
cd ~/.config/Local/addons/agent-tools/

# Windows (PowerShell)
cd "$env:APPDATA\Local\addons\agent-tools"
```

```bash
npm install --production --ignore-scripts
# Then restart Local
```

## Development

```bash
# Build the add-on
npm run build

# Watch for changes
npm run watch
```

After building, sync to the installed add-on:

```bash
# macOS
cp -R lib/* ~/Library/Application\ Support/Local/addons/agent-tools/lib/

# Linux
cp -R lib/* ~/.config/Local/addons/agent-tools/lib/

# Windows (PowerShell)
Copy-Item -Recurse -Force lib\* "$env:APPDATA\Local\addons\agent-tools\lib"
```

Then restart Local to pick up changes.

## Project Structure

```
agent-tools/
├── src/                        # Add-on source (TypeScript)
│   ├── main.ts                 # Main process — lifecycle hooks, IPC, MCP server startup
│   ├── renderer.tsx            # Renderer process — React UI
│   ├── mcp-server.ts           # HTTP MCP server — session management, Streamable HTTP transport
│   ├── helpers/
│   │   ├── site-config.ts      # SiteConfig type and SiteConfigRegistry
│   │   ├── paths.ts            # Platform-specific binary resolution (PHP, MySQL, WP-CLI)
│   │   └── port.ts             # Stable port allocation with file persistence
│   └── tools/                  # MCP tool implementations
│       ├── index.ts            # Aggregates definitions, routes handleToolCall()
│       ├── wpcli.ts            # wp_cli
│       ├── logs.ts             # read_error_log, read_access_log, wp_debug_toggle
│       ├── config.ts           # read_wp_config, edit_wp_config
│       ├── site.ts             # get_site_info, site_health_check
│       └── environment.ts      # site_start, site_stop, site_restart, site_status, list_sites
├── lib/                        # Compiled output
├── package.json
└── tsconfig.json
```

## Requirements

- Local 9.0+
- An MCP-compatible AI tool (Claude Code, Cursor, Windsurf, VS Code Copilot, etc.)

## Platform Support

macOS (darwin-arm64 and darwin-x64), Windows, and Linux.

## Support Level

**Active:** 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of Local. Bug reports, feature requests, questions, and pull requests are welcome.

## Changelog

A complete listing of all notable changes to Agent Tools are documented in [CHANGELOG.md](https://github.com/10up/localwp-agent-tools/blob/main/CHANGELOG.md).

## Contributing

Please read [CODE_OF_CONDUCT.md](https://github.com/10up/localwp-agent-tools/blob/main/CODE_OF_CONDUCT.md) for details on our code of conduct, [CONTRIBUTING.md](https://github.com/10up/localwp-agent-tools/blob/main/CONTRIBUTING.md) for details on the process for submitting pull requests to us, and [CREDITS.md](https://github.com/10up/localwp-agent-tools/blob/main/CREDITS.md) for a listing of maintainers, contributors, and libraries for Agent Tools.

## Like what you see?

[![Work with the 10up WordPress Practice at Fueled](https://github.com/10up/.github/blob/trunk/profile/10up-github-banner.jpg)](http://10up.com/contact/)

localwp-agent-tools

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README