Netlify MCP Server

🚀 Netlify CLI v19.1.5 Integration Guide with MCP Server

This guide provides a comprehensive overview of integrating Netlify CLI v19.1.5 with the MCP server, including command references, resource access URIs, limitations, and development steps.

🚀 Quick Start

If you're eager to get started, here's a high - level overview of the steps involved in integrating Netlify CLI with the MCP server. First, install the necessary dependencies, then start the development server, build the production version, and test the commands.

✨ Features

• Comprehensive Command Set: Offers a wide range of commands for site management, environment variable management, and function log viewing.
• Resource Access URIs: Provides convenient URIs for accessing site - related resources.
• Development Workflow: Includes clear steps for installation, development, production build, and testing.

📦 Installation

Install Dependencies

1. Clone the project repository:

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

2. Install npm packages:

npm install

💻 Usage Examples

Site Management

Create a Site

• Command: netlify sites:create
• Function: Create a new site using a personal access token.
• Example:

netlify sites:create --token=your PAT here

List Sites

• Command: netlify sites:list
• Function: Display a list of all sites owned by the user.

Delete a Site

• Command: netlify sites:delete
• Function: Delete a specified site using a personal access token.
• Example:

netlify sites:delete --site-id=your site ID here

Environment Variable Management

List Environment Variables

• Command: netlify env:list
• Function: Display all environment variables for a specified site.
• Example:

netlify env:list --site-id=your site ID here

Add an Environment Variable

• Command: netlify env:create
• Function: Create a new environment variable in a specified site.
• Example:

netlify env:create --site-id=your site ID here --key=NEW_VAR --value="hello world"

Update an Environment Variable

• Command: netlify env:update
• Function: Update an existing environment variable in a specified site.
• Example:

netlify env:update --site-id=your site ID here --key=EXISTING_VAR --value="new value"

Delete an Environment Variable

• Command: netlify env:delete
• Function: Delete a specific environment variable in a specified site.
• Example:

netlify env:delete --site-id=your site ID here --key=OLD_VAR

Function Logs

View Function Logs

• Command: netlify logs:functions
• Function: Display logs for a specific function in a specified site.
• Example:

netlify logs:functions --site-id=your site ID here --function=my-function-name

Development Steps

Start the Development Server

npm run dev

Build the Production Version

npm run build

Test Commands

1. List all sites:

npm run command sites:list

2. Create a new site:

npm run command sites:create -- --token=your PAT here

3. Delete a specified site:

npm run command sites:delete -- --site-id=your site ID here

Verify Environment Variable Operations

1. List all environment variables:

npm run command env:list -- --site-id=your site ID here

2. Create a new environment variable:

npm run command env:create -- --site-id=your site ID here --key=NEW_VAR --value="hello world"

3. Update an existing environment variable:

npm run command env:update -- --site-id=your site ID here --key=EXISTING_VAR --value="new value"

4. Delete an environment variable:

npm run command env:delete -- --site-id=your site ID here --key=OLD_VAR

📚 Documentation

Resource Access URIs

• netlify://sites: List all sites (equivalent to the JSON output of sites:list --json).
• netlify://sites/{siteId}/functions: List functions in a specified site (equivalent to functions:list --json, requires setting the NETLIFY_SITE_ID={siteId} environment variable).
• netlify://sites/{siteId}/env: List environment variables for a specified site (equivalent to env:list --json, requires setting the NETLIFY_SITE_ID={siteId} environment variable).

Limitations

• Interactive Commands: Commands that require user input prompts (e.g., netlify login, netlify init, netlify dev) are not supported to run through this server. Use a personal access token for authentication.
• Site Context: Multiple commands (e.g., env:*, logs:function, build, trigger - build, functions:list) require site context. This server passes the required siteId by setting the NETLIFY_SITE_ID environment variable. Commands like status and delete still require manually specifying the --site-id parameter.
• Feature Limitations: This integration currently does not support the following features:
  • Using configuration files
  • Deploying sites
  • Managing hooks
  • Managing domains

⚠️ Important Note

Interactive commands that require user input are not supported on this server. Use personal access tokens for authentication.

💡 Usage Tip

When using commands that require site context, make sure to set the NETLIFY_SITE_ID environment variable correctly.