Northbeam MCP Server

🚀 北束（Northbeam）MCP 服務器

北束（Northbeam）MCP 服務器是一款用於訪問北束營銷分析數據的 Model Context Protocol (MCP) 服務器。它提供了豐富的工具和資源，可用於查詢指標、維度、渠道表現、群體分析和歸因數據，助力用戶深入瞭解營銷效果。

🚀 快速開始

北束（Northbeam）MCP 服務器為您提供便捷的營銷分析數據訪問途徑。通過簡單的安裝步驟，您就能使用各類工具和資源進行數據查詢。

📦 安裝指南

1. 安裝依賴

npm install

2. 配置環境變量

創建一個 .env 文件，並在其中填寫您的北束（Northbeam）API 密鑰和品牌名稱：

NORTHBEAM_API_KEY=your_api_key_here
NORTHBEAM_BRAND=your_brand_name_here

3. 啟動服務器

npm run dev

💻 使用示例

基礎用法

使用 MCP 檢測工具測試

您可以通過以下命令使用 MCP 檢測工具進行測試：

npm run inspect

這將打開一個網絡界面，您可以在此測試所有可用的工具和資源。

作為 npm 包使用

您也可以將此項目作為 npm 包使用：

npx northbeam-mcp

使用 MCP 檢測工具（npm 包方式）

通過以下命令使用 MCP 檢測工具：

npx @modelcontextprotocol/inspector npx northbeam-mcp

高級用法

本服務器提供了一系列實用工具，可滿足不同的數據查詢需求：

• get_metric: 獲取北束（Northbeam）的指標數據
• list_metrics: 列出北束（Northbeam）中的所有可用指標
• list_dimensions: 列出北束（Northbeam）中的所有可用維度
• get_channel_performance: 獲取北束（Northbeam）中的渠道表現數據
• get_cohort_analysis: 獲取北束（Northbeam）中的群體分析數據
• get_attribution: 獲取北束（Northbeam）中的歸因數據

同時，還提供了特定的資源訪問方式：

• northbeam://metrics/{metric_name}: 獲取特定指標的數據