Northbeam MCP Server
About
# Northbeam MCP Server This is a Model Context Protocol (MCP) server for accessing Northbeam marketing analytics data. It provides tools and resources for querying metrics, dimensions, channel performance, cohort analysis, and attribution data from Northbeam. ## Setup 1. Install dependencies: ``` npm install ``` 2…
Explore
- Query metric data from Northbeam
- List all available metrics and dimensions
- Get channel performance data
- Perform cohort analysis
- Retrieve attribution data
- Access metric data via a URI resource
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
Northbeam MCP ServerCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
1. Install dependencies:
npm install
2. Create a .env file with your Northbeam API key and brand name:
NORTHBEAM_API_KEY=your_api_key_here
NORTHBEAM_BRAND=your_brand_name_here
3. Run the server:
npm run dev
You can also use this as an npm package:
npx northbeam-mcp
Or with the inspector:
npx @modelcontextprotocol/inspector npx northbeam-mcp
get_metric
Get metric data from Northbeam
list_metrics
List all available metrics in Northbeam
list_dimensions
List all available dimensions in Northbeam
get_channel_performance
Get channel performance data from Northbeam
get_cohort_analysis
Get cohort analysis data from Northbeam
get_attribution
Get attribution data from Northbeam
- get_metric: Get metric data from Northbeam
- list_metrics: List all available metrics in Northbeam
- list_dimensions: List all available dimensions in Northbeam
- get_channel_performance: Get channel performance data from Northbeam
- get_cohort_analysis: Get cohort analysis data from Northbeam
- get_attribution: Get attribution data from Northbeam
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"northbeam mcp server": {
"northbeam-mcp": {
"command": "npx",
"args": [
"northbeam-mcp"
],
"env": {
"NORTHBEAM_API_KEY": "",
"NORTHBEAM_BRAND": ""
}
}
}
}
}McpServers
{
"northbeam-mcp": {
"command": "npx",
"args": [
"northbeam-mcp"
],
"env": {
"NORTHBEAM_API_KEY": "",
"NORTHBEAM_BRAND": ""
}
}
}This is a Model Context Protocol (MCP) server for accessing Northbeam marketing analytics data. It provides tools and resources for querying metrics, dimensions, channel performance, cohort analysis, and attribution data from Northbeam.
## Setup
1. Install dependencies:
npm install
2. Create a .env file with your Northbeam API key and brand name:
NORTHBEAM_API_KEY=your_api_key_here
NORTHBEAM_BRAND=your_brand_name_here
3. Run the server:
npm run dev
## Testing with MCP Inspector
You can test the server using the MCP Inspector:
npm run inspect
This will open a web interface where you can test all the available tools and resources.
## Available Tools
- get_metric: Get metric data from Northbeam
- list_metrics: List all available metrics in Northbeam
- list_dimensions: List all available dimensions in Northbeam
- get_channel_performance: Get channel performance data from Northbeam
- get_cohort_analysis: Get cohort analysis data from Northbeam
- get_attribution: Get attribution data from Northbeam
## Available Resources
- northbeam://metrics/{metric_name}: Get data for a specific metric
## Usage as a Package
You can also use this as an npm package:
npx northbeam-mcp
Or with the inspector:
npx @modelcontextprotocol/inspector npx northbeam-mcp
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
