Northbeam MCP Server

Northbeam MCP サーバー

これは、Northbeam のマーケティング分析データにアクセスするための Model Context Protocol（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
```

利用可能なすべてのツールとリソースをテストできるウェブインターフェースが開きます。

## 利用可能なツール

- `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
```