mcpField
E
enonic-library-reference

enonic-library-reference

github.com/webmaxru開発0309 回インストール22 週間前に更新
リポジトリ

enonic-library-reference について

enonic-library-referenceは、Enonic XPのサーバーサイドライブラリを扱う開発者向けのエージェントスキルです。質問に応じてAPIリファレンスを案内し、関数のシグネチャや引数、戻り値、バージョン要件などを整理します。

主な機能

  1. 01質問に応じたリファレンスの選定
  2. 02関数シグネチャと引数の検索
  3. 03戻り値と使用例の提示
  4. 04複数ライブラリの利用パターン対応
  5. 05トラブルシューティングとバージョン確認
  6. 06テンプレートからのインポートブロック生成

活用シーン

  1. 01Enonic XPライブラリ関数の検索
  2. 02複数ライブラリのAPIの組み合わせ
  3. 03エラーやバージョン互換性の調査
  4. 04コントローラー用インポートブロックの準備

インストール

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

$npx skills add https://github.com/webmaxru/enonic-agent-skills --skill enonic-library-reference

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

assets/
enonic-imports.template.ts
references/
examples.md
lib-auth-reference.md
lib-cms-reference.md
lib-content-reference.md
lib-context-reference.md
lib-node-reference.md
lib-platform-reference.md
lib-portal-reference.md
lib-utilities-reference.md
lib-web-reference.md
troubleshooting.md
scripts/
.gitkeep

詳細

Enonic XP サーバーサイドライブラリリファレンス

手順

ステップ 1：対象ライブラリを特定する

  1. 質問に関連する /lib/xp/* ライブラリを特定します。

  2. ライブラリに対応するリファレンスファイルを確認します。

    ライブラリリファレンスファイル
    lib-contentreferences/lib-content-reference.md
    lib-nodereferences/lib-node-reference.md
    lib-authreferences/lib-auth-reference.md
    lib-portalreferences/lib-portal-reference.md
    lib-context, lib-event, lib-taskreferences/lib-context-reference.md
    lib-io, lib-mail, lib-repo, lib-schemareferences/lib-utilities-reference.md
    lib-project, lib-export, lib-scheduler, lib-valuereferences/lib-cms-reference.md
    lib-i18n, lib-websocketreferences/lib-web-reference.md
    lib-admin, lib-app, lib-auditlog, lib-cluster, lib-common, lib-grid, lib-vhostreferences/lib-platform-reference.md

  3. 質問が複数のライブラリにまたがる場合や、使用パターンについて尋ねている場合は、references/examples.md を読みます。

ステップ 2：関数を調べる

  1. 特定したリファレンスファイルを読みます。
  2. 関数名から該当する関数を探します。
  3. 次の情報を取り出します。
    • シグネチャ： 関数名とインポートパス。
    • パラメーター： 名前、型、必須／任意、デフォルト値、説明。
    • 戻り値の型： 返される値の型と構造。
    • 例： 正しい使い方を示すコードスニペット。

ステップ 3：回答を作成する

  1. インポート文とともに関数シグネチャを示します。
  2. 型と説明を含むパラメーターテーブルを記載します。
  3. 戻り値の型と構造を記載します。
  4. 使用例を追加します。リファレンスファイルに例がある場合は、それを使用します。ない場合は、ドキュメントに記載されたシグネチャに沿った最小限の動作する例を作成します。
  5. バージョン要件（例：「XP 7.8.0 以降が必要」）を記載します。

ステップ 4：ライブラリをまたぐパターンに対応する

  1. 質問が複数のライブラリの組み合わせに関する場合（例：「管理者としてコンテンツを作成する」）、確立されたパターンを確認するために references/examples.md を読みます。
  2. パターンがドキュメントに記載されていない場合は、関連するリファレンスファイルにある個々の関数シグネチャを組み合わせて作成します。

ステップ 5：よくある問題をトラブルシューティングする

  1. 質問にエラーや予期しない動作が記載されている場合は、references/troubleshooting.md を読みます。
  2. エラーメッセージまたは症状を既知の問題と照合します。
  3. ドキュメントに記載された修正方法と、バージョン互換性に関する注意事項を示します。

ステップ 6：インポートブロックを生成する

  1. ユーザーが再利用可能なインポートブロックを必要としている場合は、assets/enonic-imports.template.ts を読みます。
  2. ユーザーのコントローラーに必要なライブラリのみ、コメントを解除します。

エラー処理

  • 関数がどのリファレンスファイルにも見つからない場合は、コミュニティライブラリに属しているか、まだドキュメント化されていない新しい XP バージョンに含まれている可能性があることを伝え、https://developer.enonic.com/docs/xp/7.x/api を確認するよう案内します。
  • 質問が Guillotine／GraphQL、コンテンツタイプのスキーマ、または Enonic CLI に関する場合は、このスキルの対象外であることを伝えます。
  • バージョンの不一致が疑われる場合は、references/troubleshooting.md のバージョン互換性テーブルを確認します。

コメント

Markdown 対応