# Northflank — how to use (mcp.ai)

Connect your Northflank account and use 20 tools for developer tools straight from your AI agent. Connect with your own API key. The self-service developer platform that automates and unifies deployment of any workload, on any cloud, at any scale.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_northflank?ms=1787291280000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `northflank_create_or_update_project`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/northflank`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/northflank/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/northflank/create/or/update/project` — Tool to create a new project or update an existing project in Northflank (upsert operation). Use when you need to ensure a project exists with specific configuration, regardless of whether it's alread
  - body: { id: string, name: string, color?: string, region: string, networking?: object, description?: string }
- `POST https://api.mcp.ai/api/northflank/create/or/update/secret` — Tool to create or update a secret group in a Northflank project. Use when you need to store encrypted runtime variables or build arguments that can be inherited by services and jobs.
  - body: { id: string, name: string, priority: integer, projectId: string, variables: object, secretType: string, description?: string }
- `POST https://api.mcp.ai/api/northflank/create/secret` — Tool to create a secret group in a Northflank project. Use when you need to store encrypted environment variables that can be inherited by services and jobs.
  - body: { id: string, name: string, priority: integer, projectId: string, variables: object, secretType: string, description?: string }
- `POST https://api.mcp.ai/api/northflank/delete/project` — Tool to permanently delete a Northflank project and all associated resources. Use when you need to remove a project including all builds, deployments, jobs, addons, secret groups, and configurations.
  - body: { projectId: string }
- `POST https://api.mcp.ai/api/northflank/get/dns/id` — Tool to retrieve the DNS identifier for the authenticated account. Use when you need to get the DNS ID used for generating DNS entries for services and domains.
- `POST https://api.mcp.ai/api/northflank/get/project` — Tool to retrieve detailed information about a specific Northflank project. Use when you need to get project configuration, region, networking settings, or metadata.
  - body: { projectId: string }
- `POST https://api.mcp.ai/api/northflank/get/secret` — Tool to retrieve a secret from a Northflank project including its contents. Use when you need to view the actual secret values and metadata for a specific secret.
  - body: { secretId: string, projectId: string }
- `POST https://api.mcp.ai/api/northflank/get/secret/details` — Tool to view a secret with details about its linked addons from a Northflank project. Use when you need to understand addon dependencies and detailed metadata for a specific secret.
  - body: { secretId: string, projectId: string }
- `POST https://api.mcp.ai/api/northflank/list/addon/types` — Tool to retrieve information about available addon types in Northflank. Use when you need to understand what addon types are supported and their features.
- `POST https://api.mcp.ai/api/northflank/list/cloud/provider/node/types` — Tool to retrieve supported cloud provider node types available on Northflank. Use when you need to see available node types across various cloud providers including AWS, GCP, Azure, Civo, Oracle Cloud
  - body: { page?: integer, cursor?: string, per_page?: integer }
- `POST https://api.mcp.ai/api/northflank/list/cloud/provider/regions` — Tool to retrieve supported cloud provider regions available on Northflank. Use when you need to see available regions across various cloud providers including AWS, GCP, Azure, Civo, Oracle Cloud, and 
- `POST https://api.mcp.ai/api/northflank/list/pipelines` — Tool to list all pipelines for a Northflank project. Use when you need to retrieve all pipelines configured in a project.
  - body: { page?: integer, cursor?: string, per_page?: integer, projectId: string }
- `POST https://api.mcp.ai/api/northflank/list/plans` — Tool to retrieve available billing/resource plans in Northflank. Use when you need to see available plan options and their specifications.
  - body: { page?: integer, cursor?: string, per_page?: integer }
- `POST https://api.mcp.ai/api/northflank/list/projects` — Tool to list all projects in your Northflank team with pagination support. Use when you need to retrieve projects for the authenticated user or team.
  - body: { cursor?: string, per_page?: integer }
- `POST https://api.mcp.ai/api/northflank/list/regions` — Tool to retrieve available project regions in Northflank. Use when you need to see which geographic regions are available for deploying projects and resources.
- `POST https://api.mcp.ai/api/northflank/list/secrets` — Tool to list all secrets belonging to a Northflank project. Use when you need to retrieve secret groups configured in a project. Supports cursor-based pagination with default 50 results per page.
  - body: { page?: integer, cursor?: string, per_page?: integer, projectId: string }
- `POST https://api.mcp.ai/api/northflank/list/services` — Tool to list all services belonging to a Northflank project. Use when you need to retrieve services configured in a project. Supports cursor-based pagination with 50 results per page.
  - body: { cursor?: string, projectId: string }
- `POST https://api.mcp.ai/api/northflank/patch/secret` — Tool to partially update a secret group in a Northflank project. Use when you need to modify specific properties of an existing secret without providing all fields.
  - body: { name?: string, priority?: integer, secretId: string, projectId: string, variables?: object, secretType?: string, description?: string }
- `POST https://api.mcp.ai/api/northflank/update/project` — Tool to update a project in Northflank. Use when you need to modify project settings such as description, color, or advanced networking configuration.
  - body: { color?: string, projectId: string, networking?: object, description?: string }
- `POST https://api.mcp.ai/api/northflank/update/secret` — Tool to update a secret in a Northflank project. Use when you need to modify existing secret variables or add new variables to an existing secret.
  - body: { secretId: string, projectId: string, variables: object }

## Example prompts
- "What can I do in Northflank?"
- "Show me a summary of my Northflank account"

## More
- Page: https://mcp.ai/northflank
- Agent spec (llms.txt): https://mcp.ai/northflank/llms.txt
- Postman collection: https://mcp.ai/northflank/postman.json