Kajirita2002 Honeycomb MCP Server

🚀 蜂巢（Honeycomb）MCP サーバードキュメント

Honeycomb MCP（管理制御プレーン）サーバーは、Honeycomb データベースとのインターフェースです。このサーバーを使用することで、データセットの作成、クエリ、管理が可能になり、詳細なエラー処理とログ記録機能も提供されます。

✨ 主な機能

• イベント作成：バッチまたは単一のイベントの追加をサポートします。
• データセット管理：データセットの作成、更新、削除を簡単に行うことができます。
• クエリ機能：強力なフィルターと計算機能を備え、データ分析を効率的に行えます。
• エラー処理：統一されたエラー返却形式で、デバッグと異常処理が容易です。

🚀 クイックスタート

イベントの作成

Honeycomb データベースに単一のイベントを追加するには、以下の API を使用します。

POST /api/v1/event
Content-Type: application/json

{
  "dataset": "string",
  "body": {
    "key": "value"
  }
}

また、複数のイベントをバッチでアップロードすることもできます。

POST /api/v1/events
Content-Type: application/json

[
  {
    "dataset": "string",
    "body": {
      "key": "value"
    }
  },
  ...
]

データセットの作成

新しいデータセットを作成するには、以下のコマンドを使用します。

POST /api/v1/dataset
Content-Type: application/json

{
  "name": "string",
  "description": "string"
}

📚 データセット管理

データセットの更新

既存のデータセットの名前または説明を更新します。

PUT /api/v1/dataset/{datasetSlug}
Content-Type: application/json

{
  "name": "string",
  "description": "string"
}

データセットの削除

指定されたデータセットを削除します。

DELETE /api/v1/dataset/{datasetSlug}

📚 クエリ機能

基本的なクエリ

特定のデータセットのすべてのイベントを取得します。

GET /api/v1/dataset/{datasetSlug}/events

また、フィルターと計算を追加することもできます。

GET /api/v1/dataset/{datasetSlug}/query
Query Parameters:
- filter: フィルター条件、例: `column=value`
- calculate: 計算操作、例: `count(*)`

高度なクエリ

グループ化やソートなど、より複雑なクエリオプションをサポートします。

GET /api/v1/dataset/{datasetSlug}/advanced-query
Query Parameters:
- filter: フィルター条件
- groupBy: グループ化フィールド
- orderBy: ソートフィールド
- limit: 結果の件数制限

📚 エラー処理

エラー形式

エラーが発生した場合、サーバーは以下の構造を返します。

{
  "error": {
    "message": "詳細なエラー説明",
    "code": "ERROR_CODE"
  }
}

一般的なエラーコード

• AUTH_ERROR：認証に失敗しました。API キーを確認してください。
• NOT_FOUND：要求されたリソースが見つかりません。
• INVALID_REQUEST：要求の形式が正しくありません。
• INTERNAL_SERVER_ERROR：サーバー内部エラーです。

📚 トラブルシューティング

API キーの検証

使用する API キーが正しく、適切な権限を持っていることを確認します。

GET /api/v1/whoami

データセットの存在確認

クエリまたは更新操作を行う前に、対象のデータセットが存在することを確認します。

HEAD /api/v1/dataset/{datasetSlug}

📚 貢献ガイド

貢献の方法

コミュニティメンバーの皆さんからの Honeycomb MCP サーバーへの貢献を歓迎します！以下の方法で参加することができます。

• 問題報告の提出
• 機能リクエストの作成
• コードの修正や新機能の提案

開発フロー

1. リポジトリをクローンします。

git clone https://github.com/honeycomb/mcp.git

2. 依存関係をインストールします。

npm install

3. 開発サーバーを起動します。

npm run dev

📄 ライセンス

Honeycomb MCP サーバーは MIT ライセンスに準拠しています。詳細については LICENSE ファイルを参照してください。

Honeycomb MCP サーバーをご利用いただき、ありがとうございます！さらなる支援が必要な場合は、FAQ をご確認するか、サポートチームにお問い合わせください。