Quickstart

The shortest path from install to your first sync. Install the module, configure Cursor, pull a page, and push a change.

This is the fastest path from zero to a working PromptWire setup. For detailed options, see the individual docs pages linked along the way.

1. Install the module

git clone https://github.com/PeterKnightDigital/PromptWire-MCP.git site/modules/PromptWire

In ProcessWire admin: Modules > Refresh > Install PromptWire.

2. Build the MCP server

cd site/modules/PromptWire/mcp-server
npm install
npm run build

3. Configure Cursor

Create or edit .cursor/mcp.json in your project root. The args path points to the compiled MCP server inside the module, and PW_PATH is your ProcessWire install root:

{
  "mcpServers": {
    "PromptWire: My Site (Local)": {
      "command": "node",
      "args": ["/full/path/to/site/modules/PromptWire/mcp-server/dist/index.js"],
      "env": {
        "PW_PATH": "/full/path/to/your/processwire/root"
      }
    }
  }
}

If php isn't on your system PATH, add "PHP_PATH": "/path/to/php" to env. Run which php in your terminal to find it. See Installation for common paths (MAMP, Homebrew, XAMPP).

4. Test the connection

Open Cursor chat and type:

Check the site health.

You should see your ProcessWire version, template count, field count, and page count.

5. Pull a page

Ask the agent to pull a page into a local file:

Pull the About page to a local file.

This creates a YAML file at site/assets/pw-mcp/about/page.yaml with all the page's field content. You can open and edit this file directly in Cursor.

6. Edit and push

Make a change to the YAML file (or ask the agent to edit it), then push it back:

Push the About page changes back to ProcessWire.

PromptWire diffs the local file against the database, shows you what changed, and applies the update.

7. Try a natural language prompt

You don't need to know tool names. Just describe what you want:

Create a new page called "FAQ" under /about/ using the basic-page template, with a title and a short body paragraph. Dry-run first.

The agent reads your schema, picks the right tools, and previews everything before applying. See Prompt Recipes for more examples.

Next steps

  • Security — read this before connecting to any remote or production site. Covers API key management, deployment exclusions, and what should never leave your local machine.
  • Remote Setup for connecting to production or staging sites via HTTPS
  • MCP Tools Reference for the full list of 30+ tools available to the AI agent
  • Installation for detailed setup options and upgrading from PW-MCP
  • Configuration for multi-site, hybrid, and remote setups
  • Content Sync Workflow for the full pull/push lifecycle
  • Admin Dashboard for the visual sync UI in ProcessWire admin