Northbeam MCP 服务器

这是一个用于访问 Northbeam 营销分析数据的模型上下文协议 (MCP) 服务器。它提供了用于查询来自 Northbeam 的指标、维度、渠道表现、队列分析和归因数据的工具和资源。

## 设置

1. 安装依赖项：
   ```
   npm install
   ```

2. 创建一个包含您的 Northbeam API 密钥和品牌名称的 `.env` 文件：
   ```
   NORTHBEAM_API_KEY=your_api_key_here
   NORTHBEAM_BRAND=your_brand_name_here
   ```

3. 运行服务器：
   ```
   npm run dev
   ```

## 使用 MCP Inspector 进行测试

您可以使用 MCP Inspector 测试服务器：

```
npm run inspect
```

这将打开一个 Web 界面，您可以在其中测试所有可用的工具和资源。

## 可用工具

- `get_metric`: 从 Northbeam 获取指标数据
- `list_metrics`: 列出 Northbeam 中所有可用的指标
- `list_dimensions`: 列出 Northbeam 中所有可用的维度
- `get_channel_performance`: 从 Northbeam 获取渠道表现数据
- `get_cohort_analysis`: 从 Northbeam 获取队列分析数据
- `get_attribution`: 从 Northbeam 获取归因数据

## 可用资源

- `northbeam://metrics/{metric_name}`: 获取特定指标的数据

## 作为包使用

您也可以将其用作 npm 包：

```
npx northbeam-mcp
```

或者使用 inspector：

```
npx @modelcontextprotocol/inspector npx northbeam-mcp
```