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}: 获取特定指标的数据