# Northflank

```json
{
  "name": "Northflank",
  "slug": "northflank",
  "url": "https://composio.dev/toolkits/northflank",
  "markdown_url": "https://composio.dev/toolkits/northflank.md",
  "logo_url": "https://logos.composio.dev/api/northflank",
  "categories": [
    "developer tools & devops"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-03-29T06:43:32.465Z"
}
```

![Northflank logo](https://logos.composio.dev/api/northflank)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Northflank MCP or direct API to deploy workloads, manage services, monitor deployments, and automate scaling through natural language.

## Summary

Northflank is a developer platform that automates and unifies application deployment across clouds. It lets teams deploy, scale, and manage workloads at any scale with minimal setup.

## Categories

- developer tools & devops

## Toolkit Details

- Tools: 21

## Images

- Logo: https://logos.composio.dev/api/northflank

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Northflank.
  - Setup:
    - Configure Api Key credentials for Northflank.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Deploy a new service to production
- List all running deployments in staging
- Scale my web service to three instances

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `NORTHFLANK_CREATE_OR_UPDATE_PROJECT` | 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 already created. |
| `NORTHFLANK_CREATE_OR_UPDATE_SECRET` | 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. |
| `NORTHFLANK_CREATE_PROJECT` | Create Project | Tool to create a new project in Northflank. Use when you need to set up a new project with specific ID, name, region, and configuration. |
| `NORTHFLANK_CREATE_SECRET` | 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. |
| `NORTHFLANK_DELETE_PROJECT` | 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. |
| `NORTHFLANK_GET_DNS_ID` | 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. |
| `NORTHFLANK_GET_PROJECT` | 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. |
| `NORTHFLANK_GET_SECRET` | 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. |
| `NORTHFLANK_GET_SECRET_DETAILS` | 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. |
| `NORTHFLANK_LIST_ADDON_TYPES` | 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. |
| `NORTHFLANK_LIST_CLOUD_PROVIDER_NODE_TYPES` | 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, and CoreWeave. |
| `NORTHFLANK_LIST_CLOUD_PROVIDER_REGIONS` | 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 CoreWeave. |
| `NORTHFLANK_LIST_PIPELINES` | List Pipelines | Tool to list all pipelines for a Northflank project. Use when you need to retrieve all pipelines configured in a project. |
| `NORTHFLANK_LIST_PLANS` | List Plans | Tool to retrieve available billing/resource plans in Northflank. Use when you need to see available plan options and their specifications. |
| `NORTHFLANK_LIST_PROJECTS` | 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. |
| `NORTHFLANK_LIST_REGIONS` | 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. |
| `NORTHFLANK_LIST_SECRETS` | 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. |
| `NORTHFLANK_LIST_SERVICES` | 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. |
| `NORTHFLANK_PATCH_SECRET` | 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. |
| `NORTHFLANK_UPDATE_PROJECT` | 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. |
| `NORTHFLANK_UPDATE_SECRET` | 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. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Northflank Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Northflank actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Deploy a new service to the production environment'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Deploy a new service to the production environment'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for Northflank
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Northflank tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('List all running deployments in my staging environment')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'List all running deployments in my staging environment'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Northflank Integration

- Supports both Northflank MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Northflank data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Northflank access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Northflank
- Scoped, least privilege access to Northflank resources
- Full audit trail of agent actions to support review and compliance

## Use Northflank with any AI Agent Framework

Choose a framework you want to connect Northflank with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/northflank/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/northflank/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/northflank/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/northflank/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/northflank/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/northflank/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/northflank/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/northflank/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/northflank/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/northflank/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/northflank/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/northflank/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/northflank/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/northflank/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/northflank/framework/autogen)

## Related Toolkits

- [Supabase](https://composio.dev/toolkits/supabase) - Supabase is an open-source backend platform offering scalable Postgres databases, authentication, storage, and real-time APIs. It lets developers build modern apps without managing infrastructure.
- [Codeinterpreter](https://composio.dev/toolkits/codeinterpreter) - Codeinterpreter is a Python-based coding environment with built-in data analysis and visualization. It lets you instantly run scripts, plot results, and prototype solutions inside supported platforms.
- [GitHub](https://composio.dev/toolkits/github) - GitHub is a code hosting platform for version control and collaborative software development. It streamlines project management, code review, and team workflows in one place.
- [Ably](https://composio.dev/toolkits/ably) - Ably is a real-time messaging platform for live chat and data sync in modern apps. It offers global scale and rock-solid reliability for seamless, instant experiences.
- [Abuselpdb](https://composio.dev/toolkits/abuselpdb) - Abuselpdb is a central database for reporting and checking IPs linked to malicious online activity. Use it to quickly identify and report suspicious or abusive IP addresses.
- [Alchemy](https://composio.dev/toolkits/alchemy) - Alchemy is a blockchain development platform offering APIs and tools for Ethereum apps. It simplifies building and scaling Web3 projects with robust infrastructure.
- [Algolia](https://composio.dev/toolkits/algolia) - Algolia is a hosted search API that powers lightning-fast, relevant search experiences for web and mobile apps. It helps developers deliver instant, typo-tolerant, and scalable search without complex infrastructure.
- [Anchor browser](https://composio.dev/toolkits/anchor_browser) - Anchor browser is a developer platform for AI-powered web automation. It transforms complex browser actions into easy API endpoints for streamlined web interaction.
- [Apiflash](https://composio.dev/toolkits/apiflash) - Apiflash is a website screenshot API for programmatically capturing web pages. It delivers high-quality screenshots on demand for automation, monitoring, or reporting.
- [Apiverve](https://composio.dev/toolkits/apiverve) - Apiverve delivers a suite of powerful APIs that simplify integration for developers. It's designed for reliability and scalability so you can build faster, smarter applications without the integration headache.
- [Appcircle](https://composio.dev/toolkits/appcircle) - Appcircle is an enterprise-grade mobile CI/CD platform for building, testing, and publishing mobile apps. It streamlines mobile DevOps so teams ship faster and with more confidence.
- [Appdrag](https://composio.dev/toolkits/appdrag) - Appdrag is a cloud platform for building websites, APIs, and databases with drag-and-drop tools and code editing. It accelerates development and iteration by combining hosting, database management, and low-code features in one place.
- [Appveyor](https://composio.dev/toolkits/appveyor) - AppVeyor is a cloud-based continuous integration service for building, testing, and deploying applications. It helps developers automate and streamline their software delivery pipelines.
- [Backendless](https://composio.dev/toolkits/backendless) - Backendless is a backend-as-a-service platform for mobile and web apps, offering database, file storage, user authentication, and APIs. It helps developers ship scalable applications faster without managing server infrastructure.
- [Baserow](https://composio.dev/toolkits/baserow) - Baserow is an open-source no-code database platform for building collaborative data apps. It makes it easy for teams to organize data and automate workflows without writing code.
- [Bench](https://composio.dev/toolkits/bench) - Bench is a benchmarking tool for automated performance measurement and analysis. It helps you quickly evaluate, compare, and track your systems or workflows.
- [Better stack](https://composio.dev/toolkits/better_stack) - Better Stack is a monitoring, logging, and incident management solution for apps and services. It helps teams ensure application reliability and performance with real-time insights.
- [Bitbucket](https://composio.dev/toolkits/bitbucket) - Bitbucket is a Git-based code hosting and collaboration platform for teams. It enables secure repository management and streamlined code reviews.
- [Blazemeter](https://composio.dev/toolkits/blazemeter) - Blazemeter is a continuous testing platform for web and mobile app performance. It empowers teams to automate and analyze large-scale tests with ease.
- [Blocknative](https://composio.dev/toolkits/blocknative) - Blocknative delivers real-time mempool monitoring and transaction management for public blockchains. Instantly track pending transactions and optimize blockchain interactions with live data.

## Frequently Asked Questions

### Do I need my own developer credentials to use Northflank with Composio?

Yes, Northflank requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)