At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key comes from
NETLIFY_AUTH_TOKEN. - Docs: https://docs.netlify.com/api/get-started/
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
NETLIFY_AUTH_TOKEN | Yes | Netlify personal access token (User settings > Applications > Personal access tokens) Docs. |
Setup
- Sign in to Netlify: Go to https://app.netlify.com and sign in (the free Starter plan with one deployed site is sufficient for testing).
- Create a personal access token: Open User settings > Applications > Personal access tokens (https://app.netlify.com/user/applications#personal-access-tokens), select New access token, name it, and set an expiration.
- Set the environment variable: Add the token to your .env as NETLIFY_AUTH_TOKEN=…
- Verify access: Run List Sites. Site IDs accept either the UUID or the site’s domain (e.g. my-site.netlify.app).
- Tokens are sent as ‘Authorization: Bearer <token>’
- List endpoints paginate with page/per_page (max 100) and return next/prev links in the Link response header
- Triggering builds is rate limited (3 per minute, 100 per day)
Tools
| Tool | Access | Description |
|---|---|---|
| List Sites | Read | List all sites the authenticated user has access to |
| Get Site | Read | Get a site by ID or custom domain |
| List Deploys | Read | List deploys for a site |
| Get Deploy | Read | Get a deploy by ID |
| Trigger Build | Write | Trigger a new build of a site from its linked repository |
| List Form Submissions | Read | List verified form submissions across all forms of a site |
Example prompts
- List the most recent Netlify deploys for my site and summarize their states, including any error messages.
- Show the latest form submissions for my Netlify site and summarize who submitted what.