Netlify MCP server

Netlify MCP Server is a Model Context Protocol server that integrates with Netlify's API. It allows you to create, manage, and deploy sites directly from your MCP-enabled environment, providing tools for site creation, listing, information retrieval, and deletion.

Installation Options

Installing from Source

1. Clone the repository and navigate to the project directory:

git clone https://github.com/MCERQUA/netlify-mcp.git
cd netlify-mcp

2. Install the required dependencies:

npm install

3. Build the project:

npm run build

Using Docker

You can also run the server using Docker:

docker build -t netlify-mcp .
docker run -e NETLIFY_ACCESS_TOKEN=your_token_here netlify-mcp

Configuration

Obtaining a Netlify Access Token

Before using the server, you'll need to get an access token from Netlify:

1. Create a Netlify account at Netlify Signup
2. Navigate to User Settings > Applications > Personal access tokens
3. Click "New access token"
4. Name your token (e.g., "MCP Integration")
5. Copy the generated token for use in the next step

Setting Up Environment Variables

Create a .env file in the project root with your Netlify token:

NETLIFY_ACCESS_TOKEN=your_token_here

Configuring MCP Integration

Add the server to your MCP settings configuration:

{
  "mcpServers": {
    "netlify": {
      "command": "node",
      "args": ["path/to/netlify-mcp/build/index.js"],
      "env": {
        "NETLIFY_ACCESS_TOKEN": "your_token_here"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Available Tools

Creating Sites from GitHub

Create a new Netlify site from a GitHub repository:

interface CreateSiteFromGitHubArgs {
  name: string;          // Name for the new site (subdomain)
  repo: string;          // GitHub repository (format: owner/repo)
  branch?: string;       // Branch to deploy from (default: main)
  buildCommand: string;  // Build command to run
  publishDir: string;    // Directory containing the built files
  envVars?: Record<string, string>; // Environment variables
}

Listing Sites

List all Netlify sites you have access to:

interface ListSitesArgs {
  filter?: 'all' | 'owner' | 'guest';  // Filter for sites
  page?: number;         // Page number for pagination
  perPage?: number;      // Items per page (max 100)
}

Getting Site Information

Retrieve detailed information about a specific site:

interface GetSiteArgs {
  siteId: string;  // ID or name of the site
}

Deleting Sites

Delete a Netlify site:

interface DeleteSiteArgs {
  siteId: string;  // ID or name of the site
}

Troubleshooting

Common Issues and Solutions

1. Missing Access Token Error

   • Error: "NETLIFY_ACCESS_TOKEN environment variable is required"
   • Solution: Ensure you've set the token in your environment or .env file

2. Authentication Failures

   • Error: "Failed to create site: 401 Unauthorized"
   • Solution: Your access token might be invalid or expired - generate a new token from Netlify settings

3. Repository Format Problems

   • Error: "Invalid repo format"
   • Solution: Use the format owner/repo (e.g., facebook/react), not the full URL

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "netlify" '{"command":"node","args":["path/to/netlify-mcp/build/index.js"],"env":{"NETLIFY_ACCESS_TOKEN":"your_token_here"},"disabled":false,"autoApprove":[]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "netlify": {
            "command": "node",
            "args": [
                "path/to/netlify-mcp/build/index.js"
            ],
            "env": {
                "NETLIFY_ACCESS_TOKEN": "your_token_here"
            },
            "disabled": false,
            "autoApprove": []
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "netlify": {
            "command": "node",
            "args": [
                "path/to/netlify-mcp/build/index.js"
            ],
            "env": {
                "NETLIFY_ACCESS_TOKEN": "your_token_here"
            },
            "disabled": false,
            "autoApprove": []
        }
    }
}

3. Restart Claude Desktop for the changes to take effect