article
README
🚀 Netlify MCP 服务器
Netlify MCP 服务器是一个用于管理 Netlify 站点的 Model Context Protocol (MCP) 服务器。它通过 MCP 实现与 Netlify API 的无缝集成,让您能够直接在 MCP 环境中创建、管理和部署站点。
🚀 快速开始
Netlify MCP 服务器可帮助您轻松管理 Netlify 站点,下面将为您介绍如何快速搭建和使用。
✨ 主要特性
- 从 GitHub 仓库创建新站点
- 列出所有现有的 Netlify 站点
- 获取特定站点的详细信息
- 删除站点
📦 安装指南
- 克隆此仓库:
git clone https://github.com/MCERQUA/netlify-mcp.git
cd netlify-mcp
- 安装依赖项:
npm install
- 构建项目:
npm run build
🔧 配置
获取您的 Netlify 访问令牌
- 在 https://app.netlify.com/signup 注册一个 Netlify 账户。
- 进入用户设置 > 应用程序 > 个人访问令牌
- 点击“新建访问令牌”
- 给它起个名字(例如:“MCP 集成”)
- 复制生成的令牌
设置 MCP
- 在项目根目录下创建一个
.env文件:
NETLIFY_ACCESS_TOKEN=your_token_here
- 将服务器添加到您的 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; // 站点名称
repo: string; // GitHub 仓库(格式:所有者/仓库)
branch: string; // 部署分支
buildCommand: string; // 构建命令
publishDir: string; // 包含构建文件的目录
}
listSites
列出您有访问权限的所有 Netlify 站点。
interface ListSitesArgs {
filter?: 'all' | 'owner' | 'guest'; // 可选过滤器(站点类型)
}
getSite
获取特定站点的详细信息。
interface GetSiteArgs {
siteId: string; // 要检索的站点 ID
}
deleteSite
删除一个 Netlify 站点。
interface DeleteSiteArgs {
siteId: string; // 要删除的站点 ID
}
📚 详细文档
更多详细信息,请参阅:
🤝 贡献
欢迎贡献!请随意提交 Pull Request。
📄 许可证
此项目在 MIT License 下开源,详情请参阅 LICENSE 文件。
微信扫一扫