Netlify MCP server

This MCP server enables seamless integration with Netlify's API through the Model Context Protocol, allowing you to create, manage, and deploy Netlify sites directly from your MCP-enabled environment without switching contexts.

Installation

To get started with the Netlify MCP server:

1. Clone the repository:

   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
   

Configuration

Obtaining a Netlify Access Token

Before using the MCP server, you'll need to get your Netlify access token:

1. Create a Netlify account at https://app.netlify.com/signup
2. Navigate to User Settings > Applications > Personal access tokens
3. Click "New access token"
4. Provide a descriptive name (e.g., "MCP Integration")
5. Copy the generated token for use in the next steps

Setting Up Your Environment

1. Create a .env file in the project root directory:

   NETLIFY_ACCESS_TOKEN=your_token_here
   

2. Configure the server in your MCP settings:

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

Using the MCP Server

The Netlify MCP server provides several tools for managing your Netlify sites:

Creating a Site from GitHub

Create a new Netlify site from a GitHub repository:

// Example of creating a site from GitHub
{
  "name": "my-awesome-site",
  "repo": "username/repository-name",
  "branch": "main",
  "buildCommand": "npm run build",
  "publishDir": "dist"
}

Listing Your Sites

View all Netlify sites you have access to:

// List all your Netlify sites
{}

// Filter sites by your role
{
  "filter": "owner"  // Options: "all", "owner", "guest"
}

Getting Site Details

Retrieve detailed information about a specific site:

{
  "siteId": "your-site-id-here"
}

Deleting a Site

Remove a Netlify site:

{
  "siteId": "your-site-id-to-delete"
}

Tool Parameters Reference

createSiteFromGitHub

listSites

getSite

deleteSite

How to add this MCP server to 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 > MCP and click "Add new global MCP server".

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

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

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 explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.