コンテンツにスキップ

ツールリファレンス

MCP と REST API で使えるツールの一覧です。名前は MCP のツール名と REST のパス(/rest/v1/{ツール名})で共通です。

REST API は 66 のツール(通常 31 / ライト 45 / プレミアム 66)を提供します。MCP はそのうちファイル出力の 2 つを除く 64 のツール(通常 30 / ライト 44 / プレミアム 64)です。

引数と応答の詳細は、API リファレンスを参照してください。REST の公開カタログ(GET /rest/v1/tools・GET /rest/v1/openapi.json)から生成しており、プレミアムプランを基準にしています。プランによる引数の違いは、REST APIを参照してください。MCP では tools/list が、利用者のプランで使える引数を返します。

プランの列は、そのツールを使えるプランです。「全」は通常・ライト・プレミアムのすべてです。

ツール 用途 権限 プラン
getAccount プラン、登録件数と上限、今日の使用率を取得する いずれかの read 全
ツール 用途 権限 プラン
searchGames タイトル・JAN・型番・外部 ID でゲームを特定する(最大 20 件) games:read 全
searchGamesBatch 最大 20 行をまとめて特定する games:read 全
getGameDetail 1 件のゲームの詳細を取得する games:read 全
getGamesBatch 複数のゲームの詳細を取得する games:read 全
browseGames プラットフォーム・ジャンル・発売日などの条件だけでゲームを探す games:read PREMIUM
browseTagGames ゲームタグに含まれるゲームを探す games:read + library:read LIGHT / PREMIUM
listPlatforms プラットフォームの一覧と ID を取得する games:read 全
listGenres ジャンルの一覧と ID を取得する games:read 全
listCompanies 発売元の一覧と ID を取得する games:read 全
searchNews ニュースを検索する games:read 全

マイライブラリ・ウィッシュリスト

Section titled “マイライブラリ・ウィッシュリスト”
ツール 用途 権限 プラン
getLibrary マイライブラリの一覧を取得する library:read 全
addToLibrary マイライブラリに追加する(ウィッシュリストにあれば移動する) library:write 全
addToLibraryBatch マイライブラリに最大 100 件をまとめて追加する(試し実行あり) library:write 全
updateLibraryEntry マイライブラリの登録内容を更新する library:write 全
removeFromLibrary マイライブラリから削除する(プレイ記録・所有ソフトも削除) library:delete 全
getWishlist ウィッシュリストの一覧を取得する library:read 全
addToWishlist ウィッシュリストに追加する library:write 全
updateWishlistEntry ウィッシュリストの登録内容を更新する library:write 全
removeFromWishlist ウィッシュリストから削除する library:delete 全
listAttributes マイライブラリ・ウィッシュリスト・プレイ記録の属性の一覧を取得する library:read または play:read 全
getLibraryAnalytics マイライブラリを集計する(件数・評価・プラットフォーム・購入) library:read 全
ツール 用途 権限 プラン
getPhysicalCopies 1 件のゲームの所有ソフトを取得する library:read PREMIUM
addPhysicalCopy 所有ソフトを追加する(今の 1 本の明細化、または買い足し) library:write PREMIUM
updatePhysicalCopy 所有ソフトを更新する、代表の 1 本を切り替える library:write PREMIUM
removePhysicalCopy 所有ソフトを削除する library:delete PREMIUM
ツール 用途 権限 プラン
getPlayRecords ゲームごとの最新のプレイ記録を取得する play:read 全
addPlayRecord プレイ記録を作る、再プレイを始める play:write 全
updatePlayRecord 状態・日付・評価などを更新する play:write 全
removePlayRecord プレイ記録を削除する(プレイログも削除) play:delete 全
getPlayLogs プレイ記録のプレイログを取得する play:read 全
addPlayLog プレイログを追加する play:write 全
updatePlayLog プレイログを更新する play:write 全
removePlayLog プレイログを削除する play:delete 全
getGamePlayHistory 1 件のゲームの過去のプレイ記録を取得する play:read PREMIUM
getPlayAnalytics プレイ記録を集計する(状態・月別・プレイ時間の推移など) play:read 全
ツール 用途 権限 プラン
getCalendarEvents 1 か月分の購入・購入予定・プレイ開始・クリアなどの予定と記録を取得する library:read または play:read 全
ツール 用途 権限 プラン
getTags ゲームタグの一覧を取得する library:read LIGHT / PREMIUM
addTag ゲームタグを作る library:write LIGHT / PREMIUM
updateTag ゲームタグの名前・色・説明を更新する library:write LIGHT / PREMIUM
updateTagGames ゲームタグのゲームを追加・削除・置き換えする library:write LIGHT / PREMIUM
removeTag ゲームタグを削除する library:delete LIGHT / PREMIUM
ツール 用途 権限 プラン
getCollections マイコレクションの一覧を取得する library:read PREMIUM
getCollectionGames マイコレクションのゲームと達成状況を取得する library:read PREMIUM
addCollection マイコレクションを作る library:write PREMIUM
updateCollection マイコレクションを更新する library:write PREMIUM
removeCollection マイコレクションを削除する library:delete PREMIUM
ツール 用途 権限 プラン
getConsoles ゲーム機の一覧を取得する play:read LIGHT / PREMIUM
addConsole ゲーム機を登録する play:write LIGHT / PREMIUM
updateConsole ゲーム機を更新する play:write LIGHT / PREMIUM
removeConsole ゲーム機を削除する(メンテナンス記録も削除) play:delete LIGHT / PREMIUM
getConsoleMaintenanceLogs メンテナンス記録を取得する play:read LIGHT / PREMIUM
addConsoleMaintenanceLog メンテナンス記録を追加する play:write LIGHT / PREMIUM
updateConsoleMaintenanceLog メンテナンス記録を更新する play:write LIGHT / PREMIUM
removeConsoleMaintenanceLog メンテナンス記録を削除する play:delete LIGHT / PREMIUM

ゲームデータ管理で登録する、利用者自身のプラットフォーム・発売元・ゲームです。RGG の公式データは変更できません。カスタムデータの閲覧は games:read で、ゲーム情報の検索・一覧に含まれます。

ツール 用途 権限 プラン
addCustomPlatform プラットフォームを追加する games:write PREMIUM
updateCustomPlatform プラットフォームを更新する games:write PREMIUM
removeCustomPlatform プラットフォームを削除する games:delete PREMIUM
addCustomCompany 発売元を追加する games:write PREMIUM
updateCustomCompany 発売元を更新する games:write PREMIUM
removeCustomCompany 発売元を削除する games:delete PREMIUM
addCustomGame ゲームを追加する games:write PREMIUM
updateCustomGame ゲームを更新する games:write PREMIUM
removeCustomGame ゲームを削除する games:delete PREMIUM

REST API だけで使えます。MCP のツール一覧には含まれません。

ツール 用途 権限 プラン
exportMyData 自分のデータ(マイライブラリ・プレイ記録など)のダウンロード URL を発行する 対象の read(library:read / play:read / games:read) 全
exportMasterData ゲームマスタ(プラットフォーム別のゲーム、プラットフォーム、発売元、ジャンル)のダウンロード URL を発行する games:bulk PREMIUM

exportMyData で出力できるデータの種類はプランによって異なります。ゲームタグとゲーム機はライト以上、マイコレクションとカスタムゲームはプレミアムです。詳しくはREST API のファイル出力を参照してください。

名前が remove で始まるツールは、2 回の呼び出しで削除します。FREE / LIGHT の再プレイ(addPlayRecord の replay: true)も、直前のプレイ記録とプレイログを置き換えるため、同じ確認が必要です。手順は削除の確認を参照してください。