MCPツール
レポート定義の一覧を取得
sosoapi_list_report_definitionsレポート定義の一覧を取得。指定された確認済みデータセットとバージョンを使用し、ソースは自動更新しません。 レンダリング入力は sosoapi report render --output FILE にパイプで渡せます。
Markdownで読むプロファイルと通信方式
プロファイル： full · 通信方式： stdio, http
coreまたはfullで表示ツールを選べますが権限は変わりません。ローカルアップロードはstdioのみでHTTPは非対応です。SOSOAPI_OUTPUT_SCHEMAS=1で検出時に出力スキーマを含めます。設定に関係なく構造化結果を返します。
権限と副作用
注釈はクライアントがツールを説明するためのものです。各呼び出しでは引き続き認証、ロール、リソースアクセス、機能権限を確認します。
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /analytics-api/reporting/definitions/list: agent:operate · synchronous_http_response
入力フィールド
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド／分岐 | 型／必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 |
|
workspace_id | string親要素内で必須 |
|
kind | string親要素内で必須 |
|
page_size | integer任意／項目 |
|
cursor | object任意／項目 |
|
cursor.id | string親要素内で必須 |
|
cursor.version | integer親要素内で必須 |
|
history | boolean任意／項目 | — |
完全なJSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"metric",
"template"
]
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"cursor": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
"history": {
"type": "boolean"
}
},
"required": [
"workspace_id",
"kind"
],
"additionalProperties": false
}構造化された出力
このスキーマは、成功時のツール結果に含まれるstructuredContentを説明します。MCPレスポンスはcontentも含み、失敗時にisErrorを設定する場合があります。公開では、受理やテキスト応答を確認済みと扱わず、投稿の最終結果を取得してください。権限・再試行ルールはリンク先のAPI操作をご覧ください。
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド／分岐 | 型／必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 |
|
items | array親要素内で必須 |
|
items[] | object任意／項目 |
|
items[].id | string親要素内で必須 |
|
items[].kind | string親要素内で必須 |
|
items[].workspace_id | string親要素内で必須 |
|
items[].definition_id | string親要素内で必須 |
|
items[].version | integer親要素内で必須 |
|
items[].name | string親要素内で必須 |
|
items[].payload | object親要素内で必須 |
|
items[].payload.* | any JSON value任意／項目 | — |
items[].source_object_key | string | null親要素内で必須 | — |
items[].source_sha256 | string | null親要素内で必須 | — |
items[].created_at | string親要素内で必須 |
|
items[].archived | boolean親要素内で必須 | — |
next_cursor | object | null親要素内で必須 | — |
next_cursoranyOf 1 | object親要素内で必須 |
|
next_cursor.idanyOf 1 | string親要素内で必須 |
|
next_cursor.versionanyOf 1 | integer親要素内で必須 |
|
next_cursoranyOf 2 | null親要素内で必須 | — |
完全なJSON Schema
{
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"metric",
"template"
]
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"definition_id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"name": {
"type": "string",
"maxLength": 100
},
"payload": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"source_object_key": {
"type": [
"string",
"null"
]
},
"source_sha256": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"archived": {
"type": "boolean"
}
},
"required": [
"id",
"kind",
"workspace_id",
"definition_id",
"version",
"name",
"payload",
"source_object_key",
"source_sha256",
"created_at",
"archived"
],
"additionalProperties": false
}
},
"next_cursor": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"next_cursor"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}ツール呼び出しの例
スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。
{
"name": "sosoapi_list_report_definitions",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"kind": "metric"
}
}structuredContent
{
"items": [],
"next_cursor": null
}