mcpField
R
roblox-docs

roblox-docs

github.com/zilibobi開発3102 回インストール21 週間前に更新
リポジトリ

roblox-docs について

roblox-docsは、AgentがRoblox/Luauの公式ドキュメントを参照するためのスキルです。更新の速いAPIの確認や実装計画に役立ち、自動更新されるローカル文書を検索して、出典付きの結果を返します。

主な機能

  1. 01公式ドキュメントのローカル複製を検索
  2. 02クラス・型・列挙型・ガイドを網羅
  3. 03ドキュメント複製の自動更新
  4. 04出典付きの簡潔な回答
  5. 05オフライン時はキャッシュを利用

活用シーン

  1. 01API名・引数・戻り値の確認
  2. 02動作・例外条件・非推奨情報の調査
  3. 03APIや実装方法の比較
  4. 04計画段階でAPIの根拠を確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/zilibobi/roblox-skills --skill roblox-docs

インストール後、Claude Code で/roblox-docsを入力して読み込まれたか確認します。

同梱ファイルscripts/robloxdocs.pytests/test_robloxdocs.py

詳細

Roblox creator-docs の検索

このスキルは、記憶ではなく 公式 ドキュメントを参照して、Roblox／Luau に関する質問に回答します。Roblox/creator-docs のローカルクローンを自動更新しながら利用するため、常に最新の情報を参照でき、すべてのクラス、データ型、列挙型、グローバル、ライブラリ、ガイドを一度に全文検索できます。これは、単一のドキュメントページをライブウェブから取得するだけではできません。

どんなときに使うか

これは主に、API の仕様がトレーニングデータより速く変化する中で、エージェントであるあなたが正確さを保つためのツールです。ユーザーから「ドキュメントを見て」と頼まれるまで待たないでください。次のようなときに使います。

  • 確信がないとき。 API 呼び出し（メソッド名、引数、戻り値の型、列挙値、プロパティなど）を記述または推奨しようとしていて、それが正しく最新であると完全には確信できない場合です。確認にはほとんど手間がかかりませんが、誤ったシグネチャをでっち上げると、ユーザーは実際にデバッグに時間を費やすことになります。
  • 詳しい情報が必要なとき。 タスクに名前だけでなく、動作、エッジケース、非推奨化、代替手段、各要素の連携方法などが必要な場合です。
  • 代替案を検討するとき。 目的を達成する API や方法が複数あり、ドキュメントが実際にどれを推奨しているか比較したい場合です。
  • 計画を立てるとき。 特に計画段階では、方針を固める前にドキュメントを確認し、誤った前提に基づいた計画を立てないようにしてください。実際の API に基づく計画なら、後からやり直す必要がありません。

迷ったら調べてください。自信たっぷりの推測を、出典付きの事実に置き換えることがこのツールの目的です。

サブエージェントを使う理由

ドキュメントファイルは大きく、単一クラスの YAML が数千行に及ぶこともあります。複数のファイルをこの会話に直接読み込むと、生のリファレンス情報に埋もれて、実際の回答が見えにくくなります。そこで、検索とファイル全体の読み込みを独自のコンテキストで行い、簡潔な出典付きの回答だけを返す Explore サブエージェントに委任します。あなたのコンテキストはすっきり保たれます。

使い方

Roblox／Luau に関する質問が出たら、以下のプロンプトを使って、Agent ツール経由で Explore サブエージェントを 1 つ起動します。検索スクリプトは次の場所にあります。

${CLAUDE_PLUGIN_ROOT}/skills/roblox-docs/scripts/robloxdocs.py

この絶対パスとユーザーの質問を、次のプロンプトに置き換えます。

公式 Roblox ドキュメントを調べて、質問に回答してください。 同梱の検索ツールを使用し、ウェブから取得したり、記憶に基づいて回答したりしないでください。

  1. 実行します：python3 <SCRIPT_PATH> "<search query>" 初回の実行時にドキュメントをクローンします（約 1 分）。以降の実行ではキャッシュされたクローンを再利用し、古くなっている場合は自動で最新の状態にします。スニペットとともに、関連度順の path:line 一致箇所が表示されます。
  2. 最も関連性の高いファイルを選び、Read で全文を読みます（スニペットは順位付け用にすぎません。実際の回答はファイル内にあります）。
  3. 最初の検索で見つからない場合は、別の語句（正確な API 名、関連するクラス、機能を平易に表す名前など）を使って再検索してください。このツールは TweenService:Create のようなドット形式やコロン形式に対応しています。
  4. 簡潔に回答します。関連する API シグネチャや手順、必要に応じて短いコード例を示し、各事実にクローン内の path:line を出典として付けてください。ドキュメントに記載がない場合は、そう伝えてください。API をでっち上げてはいけません。

質問：<THE USER'S QUESTION>

その後、出典を維持したまま、サブエージェントの回答をユーザーに伝えます。

注記

  • 前提条件： PATH 上に git と Python 3 が必要です。ripgrep（rg）があれば検索が高速になりますが、必須ではありません。
  • 最新性： クローンは 24 時間以上経過すると自動で最新の状態になります。強制的に更新するには、サブエージェント（またはあなた）が python3 <SCRIPT_PATH> --update を実行します。
  • 複数の質問： 関連する検索を 1 つのサブエージェント用プロンプトにまとめてください。サブエージェントが一度に検索と読み込みを行えるため、何度も起動せずに済みます。
  • オフライン： 更新に失敗した場合、ツールはキャッシュ済みのクローンに切り替えて、その旨を通知します。回答はやや古い可能性がありますが、引き続き利用できます。

コメント

Markdown 対応