Netlify MCP Server

Netlify MCP 服务

用于管理 Netlify 站点的模型上下文协议（MCP）服务。此服务通过 MCP 与 Netlify API 无缝集成，让你能够直接在支持 MCP 的环境中创建、管理和部署站点。

功能

• 🚀 从 GitHub 仓库创建新站点
• 📋 分页列出已有的 Netlify 站点
• 🔍 获取详细的站点信息
• 🗑️ 删除站点
• 🔐 使用 Netlify API 进行安全身份验证
• ⚡ 使用 TypeScript 构建，确保类型安全
• 🐳 支持 Docker，便于部署

要求

• Node.js 18 或更高版本
• 拥有 API 访问权限的 Netlify 账户
• 用于部署站点的 GitHub 仓库

安装

从源代码安装

1. 克隆此仓库：

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

2. 安装依赖：

npm install

3. 构建项目：

npm run build

使用 Docker

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

配置

获取 Netlify 访问令牌

1. 在 https://app.netlify.com/signup 创建 Netlify 账户
2. 前往 User Settings > Applications > Personal access tokens
3. 点击 “New access token”
4. 为其命名（例如 “MCP Integration”）
5. 复制生成的令牌

设置 MCP

1. 在项目根目录创建 .env 文件：

NETLIFY_ACCESS_TOKEN=your_token_here

2. 将服务添加到 MCP 设置配置中：

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

可用工具

createSiteFromGitHub

从 GitHub 仓库创建新的 Netlify 站点。

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
}

listSites

列出你有权访问的所有 Netlify 站点。

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

getSite

获取特定站点的详细信息。

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

deleteSite

删除 Netlify 站点。

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

文档

如需了解更多详情，请参阅：

• 设置指南
• API 文档
• 使用示例

开发

# Run in development mode with auto-rebuild
npm run dev

# Clean build artifacts
npm run clean

# Build the project
npm run build

故障排除

常见问题

1. “NETLIFY_ACCESS_TOKEN environment variable is required”

   • 确保已在环境变量或 .env 文件中设置令牌

2. “Failed to create site: 401 Unauthorized”

   • 你的访问令牌可能无效或已过期
   • 在 Netlify 设置中生成新令牌

3. “Invalid repo format”

   • 确保仓库格式为 owner/repo
   • 示例：facebook/react，而不是 https://github.com/facebook/react

贡献

欢迎贡献！请随时提交 Pull Request。

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 将分支推送到远程仓库（git push origin feature/amazing-feature）
5. 发起 Pull Request

许可证

此项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

致谢

• 感谢 Model Context Protocol 提供 MCP 框架
• 感谢 Netlify 提供出色的部署平台