Tool / MCP 一覧の照会

指定した組織配下の Tool と MCP の一覧を照会できます。

本インターフェースを使用して、指定した組織配下の Tool と MCP の一覧を照会できます。

リクエストメソッド

GET

リクエストURL

https://api.${endpoint}/v1/org/tool/list

リクエスト認証

アカウントレベルの DevKey / DevSecret による Basic 認証を使用します。

リクエスト

リクエスト例

curl -X GET 'https://api.${endpoint}/v1/org/tool/list?org_id=p-xxxx&plugin_type=TOOL&available=true&keyword=weather' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/org/tool/list?org_id=p-xxxx&plugin_type=TOOL&available=true&keyword=weather' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Basic ${BASIC_TOKEN}	`DevKey:DevSecret` を Base64 エンコードした Basic Token を使用します。

リクエストパラメータ（Query Parameters）

パラメータ	タイプ	説明	required
org_id	String	組織 ID。	true
keyword	String	キーワード。名称または説明でフィルタリングします。	false
plugin_type	String	リソースタイプ。`TOOL`、`MCP` をサポート。指定しない場合は Tool と MCP を返します。	false
available	Boolean	利用可能または利用不可のリソースのみを返すかどうか。	false

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "data": [ { "resource_id": "tool-xxxx", "name": "weather", "display_name": "Weather Lookup", "description": "Query current weather", "logo": "https://cdn.example.com/weather.png", "url": "https://api.example.com", "plugin_type": "TOOL", "available": true, "action_count": 2, "create_time": 1785826041000, "update_time": 1785826041000 } ] }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": [
    {
      "resource_id": "tool-xxxx",
      "name": "weather",
      "display_name": "Weather Lookup",
      "description": "Query current weather",
      "logo": "https://cdn.example.com/weather.png",
      "url": "https://api.example.com",
      "plugin_type": "TOOL",
      "available": true,
      "action_count": 2,
      "create_time": 1785826041000,
      "update_time": 1785826041000
    }
  ]
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
resource_id	String	Tool または MCP ID。
name	String	リソース名称。
display_name	String	表示名称。
description	String	説明。
logo	String	アイコン URL。
url	String	サービスアドレス。
plugin_type	String	リソースタイプ。`TOOL` または `MCP`。
available	Boolean	利用可能かどうか。
action_count	Integer	Action の数。
create_time	Long	作成時刻、ミリ秒タイムスタンプ。
update_time	Long	更新時刻、ミリ秒タイムスタンプ。

エラー時のレスポンス

フィールド	タイプ	説明
code	Integer	エラーコード。
message	String	エラー詳細。

ステータスコード

ステータスコード	説明
200	成功
400	パラメータエラー
401	未認証
403	権限不足
429	リクエストが頻繁すぎます
500	サーバーエラー