Netlify MCP

🚀 Netlify MCP Server

A Model Context Protocol (MCP) server for managing Netlify sites. This server seamlessly integrates with the Netlify API through MCP, allowing you to create, manage, and deploy sites directly from the MCP environment.

✨ Features

• Create new sites from GitHub repositories.
• List all existing Netlify sites.
• Get detailed information about a specific site.
• Delete sites.

📦 Installation

1. Clone this repository:

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

2. Install dependencies:

npm install

3. Build the project:

npm run build

🛠️ Configuration

Get Your Netlify Access Token

1. Sign up for a Netlify account at https://app.netlify.com/signup.
2. Go to User Settings > Applications > Personal access tokens.
3. Click "New access token".
4. Give it a name (e.g., "MCP Integration").
5. Copy the generated token.

Set Up MCP

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

NETLIFY_ACCESS_TOKEN=your_token_here

2. 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": []
    }
  }
}

💻 Usage Examples

Basic Usage

createSiteFromGitHub

Create a new Netlify site from a GitHub repository.

interface CreateSiteFromGitHubArgs {
  name: string;          // Site name
  repo: string;          // GitHub repository (format: owner/repo)
  branch: string;        // Deployment branch
  buildCommand: string;  // Build command
  publishDir: string;    // Directory containing build files
}

listSites

List all Netlify sites you have access to.

interface ListSitesArgs {
  filter?: 'all' | 'owner' | 'guest';  // Optional filter (site type)
}

getSite

Get detailed information about a specific site.

interface GetSiteArgs {
  siteId: string;  // ID of the site to retrieve
}

deleteSite

Delete a Netlify site.

interface DeleteSiteArgs {
  siteId: string;  // ID of the site to delete
}

📚 Documentation

For more detailed information, please refer to:

• Installation Guide
• API Documentation
• Usage Examples

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is open-source under the MIT License. For details, please refer to the LICENSE file.