98 lines
6.2 KiB
Markdown
98 lines
6.2 KiB
Markdown
---
|
|
sidebar_position: 1
|
|
_i18n_hash: 3bea21234680fc0342392f5d9887ba15
|
|
---
|
|
# エージェントスキルの統合
|
|
|
|
## はじめに
|
|
|
|
**Tianji データクエリスキル**は、AIエージェント(Cursor, Claude Code, Codex, Copilot CLI など)が Tianji プラットフォームに直接クエリを行うことを可能にする軽量でエージェント非依存のスキルバンドルです。このスキルは、読み取り専用の OpenAPI を介して実現されています。
|
|
|
|
これは、単一の `SKILL.md` と参考ファイルによる[agentskills.io](https://agentskills.io/specification)仕様に従っています。長期実行プロセスや追加のランタイムは不要です。
|
|
|
|
::: tip 始めるには
|
|
[インストールガイド](./installation.md)をご覧ください。ワンクリックでのセットアップと手動の設定方法があります。
|
|
:::
|
|
|
|
**含まれる内容:** 14のサービス領域にわたる69のGETエンドポイント:
|
|
|
|
- **ウェブサイト** — トラフィック統計、ページビュー、地理分布、Lighthouseレポート
|
|
- **モニター** — アップタイムステータス、最近のチェックデータ、モニターイベント
|
|
- **サーベイ** — 調査回答、結果統計、AIカテゴリ
|
|
- **テレメトリー** — カスタムイベントカウント、テレメトリーページビュー、メトリクス
|
|
- **フィード** — チャンネル、イベントストリーム、フィードステータス
|
|
- **アプリケーション** — アプストアレビュー、アプリ情報、イベント統計
|
|
- **課金 / AI ゲートウェイ / ワーカー / ページ / ワークスペース / グローバル / 監査ログ**
|
|
|
|
## スキル対MCPサーバー
|
|
|
|
TianjiはAIエージェントと統合するための2つの方法を提供します。ワークフローに合ったものを選んでください。
|
|
|
|
| | エージェントスキル | [MCPサーバー](/docs/mcp) |
|
|
|--|--|--|
|
|
| **形式** | プレーンなドキュメントファイル (`SKILL.md` + リファレンス) | 長期実行のNode.jsプロセス |
|
|
| **ランタイム** | なし — エージェントが`curl`や組み込みのHTTPツールを使用 | `npx tianji-mcp-server` |
|
|
| **対応範囲** | 69のGETエンドポイント(読み取り専用、すべての表面) | 選定されたツールセット(読み取り+一部書き込み) |
|
|
| **セットアップ** | ファイルをエージェントのスキルディレクトリにドロップ | MCP設定をエージェントの設定ファイルに追加 |
|
|
| **最適なエージェント** | Cursor / Claude Code / Codex / agentskills.io 仕様に従うエージェント | MCPサポートを備えたエージェント |
|
|
|
|
両方を同時に使用しても問題ありません。
|
|
|
|
## 使用例
|
|
|
|
インストール後、AIエージェントに自然言語で質問すると、適切なエンドポイントを選択して応答します。
|
|
|
|
### 例1: ウェブサイトのトラフィック概要
|
|
|
|
```
|
|
ユーザー: メインウェブサイトの過去7日間のページビューを見せてください。
|
|
|
|
エージェント: [サイトを見つけるためにGET /open/workspace/{workspaceId}/website/allを呼び出し]
|
|
[その後、GET /open/workspace/{workspaceId}/website/{websiteId}/pageviews
|
|
で7日の開始終了時間を指定して呼び出し]
|
|
メインウェブサイトは過去7日間に12,438のページビューを受け取り、
|
|
火曜日にピークの2,103を記録しました。最も多かったリファラー:google.com (43%)。
|
|
```
|
|
|
|
### 例2: モニターの健康チェック
|
|
|
|
```
|
|
ユーザー: 現在ダウンしているモニターはありますか?
|
|
|
|
エージェント: [GET /open/workspace/{workspaceId}/monitor/allを呼び出し]
|
|
[各モニターに対してGET /open/workspace/{workspaceId}/monitor/{monitorId}/statusを呼び出し]
|
|
現在2つのモニターがダウンしています:
|
|
- api.example.com (HTTP 503、最後のアップ12分前)
|
|
- db-replica (TCPタイムアウト、最後のアップ1時間前)
|
|
残りの8つのモニターは正常です。
|
|
```
|
|
|
|
### 例3: 調査結果の分析
|
|
|
|
```
|
|
ユーザー: "Q4顧客フィードバック"調査の回答を要約してください。
|
|
|
|
エージェント: [IDを解決するためにGET /open/workspace/{workspaceId}/survey/allを呼び出し]
|
|
[次にGET /open/workspace/{workspaceId}/survey/{surveyId}/statsを呼び出し]
|
|
[ページネーションクルーサを使用してGET /open/workspace/{workspaceId}/survey/{surveyId}/result/listを呼び出し]
|
|
"Q4顧客フィードバック"は218の回答を受け取りました。平均満足度は4.3/5。
|
|
トップテーマはダッシュボードのパフォーマンス(47回の言及)。
|
|
最も要望の多かった機能はダークモード(31回の言及)。
|
|
```
|
|
|
|
## 機密データの取り扱い
|
|
|
|
一部のエンドポイントはプラットフォームに保存された秘密情報(例: AIゲートウェイの`modelApiKey`、`customModelBaseUrl`)やPII(ワークスペースメンバー、監査ログ、課金)を返す可能性があります。
|
|
|
|
スキルはエージェントに以下を指示します:
|
|
|
|
- **決して表示しない**: `apiKey`、`modelApiKey`、`secret`、`token`、`password`、`credential` フィールド。
|
|
- 応答を要約する際に**これらのフィールドを抹消または省略する**。
|
|
- ワークスペースメンバーや監査ログについては、ユーザーが明示的に完全な詳細を求めない限り、非機密なメタデータ(名前、役割、タイムスタンプ)のみを表面化する。
|
|
|
|
バンドルされた`openapi-readonly.json`はこれらのフィールドをスキーマレベルで事前に抹消しているため、エージェントが構造に頼ることができません。
|
|
|
|
## ソース
|
|
|
|
スキルソースはTianjiリポジトリの[`skills/tianji-data-query/`](https://github.com/msgbyte/tianji/tree/master/skills/tianji-data-query)にあります。プルリクエストを歓迎します。
|