メインコンテンツまでスキップ

Kuroco Skills リファレンス

このページでは、Kuroco Skills に含まれる 9 つのスキルについて詳しく説明します。

kuroco-docs - ドキュメント検索

Kuroco 公式ドキュメントの検索・参照を支援するスキルです。

機能

  • プラグインに同梱された公式ドキュメントの横断検索
  • 目的別クイックリファレンス(API、認証、フロントエンド、コンテンツ管理など)

使用例

「Kuroco のエンドポイント設定方法を知りたい」
「ログイン API の仕様を調べたい」
「フィルタークエリの書き方を教えて」

同梱ドキュメントの構成

公式ドキュメントの各ページは、カテゴリ単位の統合ファイルとして収録されています。1 つの統合ファイルに複数の公式ページが含まれ、各ページの見出し直下に元ページの slug と公式サイト URL が記載されています。

ファイル内容
INDEX.md全ファイルの一覧と収録ページ数
tutorials-*.mdチュートリアル(auth-member / frontend / content / api-custom / ai-mcp / ec / form-mail / integration / admin-customize / misc)
reference-*.mdリファレンス(api / content / smarty-trigger / mcp-ai / file / misc)
management-*.md管理画面ガイド(account / api / campaign / content / ec / integration / member / operation / misc)
faq-*.mdFAQ(content / frontend / api / api-error / admin / email-form / domain / file / login-session / password / smarty / tls / infrastructure / deploy / member / email / assessment / contracts / other)
about.mdKuroco の概要、料金、制限事項、セキュリティ
troubleshooting.mdトラブルシューティング
注記

お知らせ・リリースノートは鮮度が重要なため同梱されていません。これらは公式サイト(https://kuroco.app/ja/docs/ )を参照してください。


kuroco-app-builder - アプリ・サイトの構築ワークフロー

Kuroco で Web アプリ・サイトをゼロから構築する手順全体をオーケストレーションするスキルです。個別機能の実装は各専門スキルに委譲し、進め方(フェーズ設計)と橋渡しを担当します。

機能

  • フロントエンド先行(モックファースト)の構築フロー
  • 機能 → Kuroco 機能のマッピング表(コンテンツ定義、カテゴリ、メンバー、フォーム、お気に入り、コメント、EC など)
  • 認証方式の決定基準(認証なし / Cookie 認証 / 動的アクセストークン / 静的アクセストークン)
  • Admin MCP のスコープ事前確認(whoami)と、着手可否の判断
  • モックデータを Kuroco API のレスポンス形({ list, pageInfo } / { details })で作る契約と、実 API への差し替えパターン
  • 進行チェックリストとアンチパターン集

使用例

「Kuroco でアプリを丸ごと作りたい」
「サイトを新規で構築して」
「ブログサイトを作りたい。まず動く画面を見せて」
「会員サイトをゼロから構築して」

対応するキーワード

アプリ構築 サイト構築 プロトタイプ モックファースト フロントエンド先行 コンテンツ定義 TopicsGroup エンドポイント作成 KurocoFront デプロイ whoami mcp:tools.all

構築フェーズ

フェーズ内容
フェーズ 0要件ヒアリング、機能 → Kuroco 機能マッピング、認証方式の決定、Admin MCP のスコープ確認
フェーズ 1モックデータでのフロントエンド構築と画面確定
フェーズ 2コンテンツ定義・カテゴリ・サンプルデータの作成(Admin MCP)
フェーズ 3エンドポイント作成とセキュリティ設定
フェーズ 4実データ接続、認証・フォーム接続、デプロイ
注記

データモデルが確定している場合や画面が定型の場合は、バックエンド先行(フェーズ 2 → 3 → 1 → 4)に切り替えることもできます。


kuroco-api-content - API 連携 & コンテンツ管理

Kuroco API の設計・実装およびコンテンツ管理(CRUD 操作)に関するベストプラクティスを提供するスキルです。 旧 kuroco-api-integrationkuroco-content-management を統合したスキルです。

機能

API 連携:

  • エンドポイント設計パターン(URL 構造、主要モデル、オペレーション)
  • 認証方式(なし / 静的アクセストークン / 動的アクセストークン / Cookie)
  • CORS 設定、キャッシュ戦略、流量制限
  • エラーハンドリングパターン(401 / 403 / 429)

コンテンツ管理:

  • コンテンツ構造(Topics / TopicsGroup / TopicsCategory)
  • 拡張項目(カスタムフィールド)の設定・利用方法
  • Topics API のオペレーション(list / details / insert / update / delete / bulk_upsert)
  • フィルタークエリの構文と使い方、ページネーション
  • 多言語対応(langs_open_flg
  • ファイルアップロード、CSV インポート/エクスポート
  • EC ポイントの操作(ECPoint)

使用例

「Kuroco の API でログインを実装したい」
「トークン認証の使い方を教えて」
「CORS のエラーが出る。設定方法は?」
「Kuroco でコンテンツ定義を作りたい」
「記事の一覧を API で取得したい」
「フィルターで特定カテゴリの記事だけ取得したい」

対応するキーワード

Kuroco API エンドポイント設定 認証 CORS Cookie認証 動的アクセストークン 静的アクセストークン JWT 流量制限 credentials include 401エラー 403エラー 429エラー pageInfo ページネーション langs_open_flg コンテンツ定義 Topics カテゴリ WYSIWYG ファイルアップロード CSVインポート ext_col filter order_query bulk_upsert topics_flg 拡張項目 ECPoint

主な認証方式の比較

認証方式推奨ユースケース特徴
なし開発・テスト用(本番非推奨)ヘッダー不要
静的アクセストークンサーバー間通信、公開 API固定トークンを X-RCMS-API-ACCESS-TOKEN ヘッダーに付与
動的アクセストークンログイン必須サイト(JWT)ログインで取得したトークンを X-RCMS-API-ACCESS-TOKEN ヘッダーに付与
Cookieログイン必須の Web サイトセッションベース。credentials: 'include' が必須

フィルタークエリの基本構文

演算子
=, !=filter=category_id = 1
>, >=, <, <=filter=ymd >= "2024-01-01"
contains, ncontainsfilter=subject contains "キーワード"
in, ninfilter=category_id in [1, 2, 3]
注記

文字列の値は二重引用符で囲みます。シングルクォートは引用符ごと値の一部として扱われるため、エラーにならず 0 件になります。


kuroco-frontend-integration - フロントエンド統合 & KurocoFront デプロイ

Kuroco と Vite / Nuxt.js / Next.js の統合パターンおよび KurocoFront へのデプロイを提供するスキルです。 旧 kuroco-ai-deployment の機能を統合しています。

実践的なチュートリアルは Kuroco サンプルサイトチュートリアル を参照してください。

機能

フロントエンド統合:

  • Vite + Vue 3 / Nuxt 3 / Nuxt 2 / Next.js(App Router / Pages Router)の統合パターン
  • 環境変数設定、プロジェクト構成例
  • 認証実装(ログイン / ログアウト / ログイン状態確認 / 会員登録)
  • SPA / SSG / SSR 設定
  • KurocoPages との連携
  • サードパーティ Cookie 問題への対応、XSS 対策

KurocoFront デプロイ:

  • kuroco_front.json の設定
  • GitHub リポジトリ連携によるデプロイ
  • Admin MCP からの直接デプロイ(zip アップロード → KurocoFront-deployKurocoFront-history で反映確認)
  • プレビューデプロイ(is_preview)/ 本番デプロイ、上書き時の注意点

使用例

「Nuxt3 で Kuroco のコンテンツを表示したい」
「Next.js で Kuroco の認証を実装したい」
「SSG で静的サイトを生成したい」
「Safari でログインできない(Cookie の問題)」
「Kuroco のサイトを KurocoFront にデプロイしたい」
「プレビュー環境にデプロイして確認したい」

対応するキーワード

Vite Nuxt3 Next.js App Router SPA SSG SSR useAsyncData $fetch composable useAuth KurocoPages credentials include サードパーティCookie XSS KurocoFront kuroco_front.json GitHub連携 KurocoFront-deploy KurocoFront-history artifact_url stage_url is_preview CI/CD

フレームワーク別の推奨

フレームワーク推奨ユースケース
Vite + Vue 3シンプルな SPA(SEO 不要のアプリ・ツール類)
Nuxt.js 3.xSEO が必要なコンテンツサイト(SSG で静的 HTML 生成、推奨)
Nuxt.js 2.x既存 Vue プロジェクト
Next.js 13+(App Router)新規 React プロジェクト
Next.js(Pages Router)既存 React プロジェクト

デプロイ方法

方法内容
GitHub 連携管理画面 [KurocoFront] → GitHub リポジトリ連携。push 時に GitHub Actions でビルドし、成果物をデプロイ
Admin MCP からの直接デプロイビルド成果物の zip をアップロードし、KurocoFront-deploy でデプロイ(非同期)。KurocoFront-history で反映を確認
上書きについて

1 つのドメインで公開されるのは現行デプロイ 1 つだけで、新しいデプロイは既存の公開内容を置き換えます。本番反映前に is_preview: true でのプレビューデプロイによる確認を推奨します。


kuroco-server-processing - Smarty プラグイン & バッチ処理

Kuroco の Smarty テンプレートの完全リファレンスおよびバッチ処理・Webhook・トリガーを使った自動化パターンを提供するスキルです。 旧 kuroco-smarty-pluginskuroco-webhook-processing を統合したスキルです。

機能

Smarty プラグインリファレンス:

  • 206 個のプラグインの完全なリファレンス
  • カテゴリ別索引(API / 文字列 / 配列 / フォーム / 認証 / 外部連携 / ファイル / Vue.js)
  • Smarty 基本構文(変数代入、ループ、条件分岐、修飾子)
  • セキュリティ設定(IF_FUNCS / MODIFIER_FUNCS)

バッチ処理 & Webhook:

  • バッチ処理の設定方法と実行頻度
  • 内部 API 呼び出し(api_internal
  • 外部 API 呼び出し(api_request
  • トリガー処理(コンテンツ更新時 / フォーム送信時)、トリガーメールアドレス
  • 外部サービス連携(Slack / Chatwork / SendGrid / メール / GitHub Actions)

使用例

「Smarty で記事一覧を取得して表示したい」
「sendmail プラグインの使い方を教えて」
「Smarty で JSON をパースする方法は?」
「バッチ処理で毎日 CSV を生成したい」
「コンテンツ更新時に Slack に通知を送りたい」
「GitHub Actions でデプロイをトリガーしたい」

対応するキーワード

Smartyプラグイン Smarty関数 Smarty修飾子 assign foreach escape date_format api_internal sendmail slack_post_message ai_completion write_file バッチ処理 Webhook 定期実行 cron Slack通知 Chatwork SendGrid GitHub Actions api_request トリガー トリガーメールアドレス カスタム処理

カテゴリ別リファレンス

カテゴリ主なプラグイン
API・データ取得api_internal, assign_topics_list, assign_tag_list
文字列処理escape, truncate, date_format, translate
配列操作count, in_array, implode, explode
フォーム・UIfileupload, inquiry_input, pager
認証・権限rcms_auth, login, logout
外部連携sendmail, slack_post_message, ai_completion
ファイル操作write_file, put_file, read_file
Vue.js 連携rcms_vue_component, head_include

バッチ処理の実行頻度

頻度用途
15 分毎頻繁な同期が必要な場合
30 分毎準リアルタイム処理
1 時間毎定期的な集計・更新
毎日(指定時刻)日次レポート、バックアップ

kuroco-admin-mcp - Admin MCP 接続 & 管理操作

Admin MCP(管理 MCP サーバ)への接続設定と、MCP ツールによる管理操作を支援するスキルです。 AI エージェントから Kuroco の管理操作を行う場合の推奨手段です。

機能

  • モジュールスコープ付きエンドポイント URL の組み立て方(/x/all/x/all/readonly/x/topics_group_5 など)
  • 3 つの認証方式(OAuth 2.0 認可コードフロー / 特権静的トークン / 管理セッション)と CIMD の利用
  • OAuth スコープの権限レベル設計(mcp:tools.read / mcp:tools.write / mcp:tools.all / mcp:admin の 4 レベル、リソース単位スコープ)
  • whoami による実効権限の事前確認
  • Claude Code・Claude(Web / Desktop)・ChatGPT からの接続設定
  • ツールの命名規則({リソース}-{動詞})と利用フロー、ファイルアップロード(ステージング → 参照渡し)
  • 「ツールが見えない」「audience 不一致」「エンドポイント作成だけ権限エラー」などのトラブルシューティング

使用例

「Claude Desktop から Kuroco を操作したい」
「Admin MCP に接続したい」
「MCP のツールが表示されない原因を知りたい」
「読み取り専用で MCP を使いたい」

対応するキーワード

Admin MCP MCP サーバ MCP 接続 OAuth CIMD Issuer URL mcp:admin mcp:tools.all mcp:tools.write mcp:tools.read whoami スコープ tools/list 特権静的トークン

スコープの権限レベル

スコープできること
mcp:tools.read全モジュールの読み取りのみ(書き込み不可)
mcp:tools.writetopics / csvtable / tag / comment 等の登録・更新。削除は不可で、rcms_api member group batch は含まれない
mcp:tools.all全モジュール・全操作(下記の例外を除く)
mcp:admin制約なし。スーパーユーザーのみ承認可能

mcp:tools.write は単独では選べず、mcp:tools.read とセットで付与されます。mcp:tools.all でも、権限グループと汎用 Smarty バッチの作成・変更・削除、メンバーへのスーパーユーザーグループ付与、特権付き静的トークンの発行はできません。

注記

API 定義・エンドポイントの作成には mcp:tools.all 以上が必要です。コンテンツ定義の作成は mcp:tools.write で進むため、エンドポイント作成の手前で初めて失敗します。着手前に whoamipermissions.connection.scope を確認してください。

前提条件

  • 対象サイトの管理メンバーアカウント(OAuth 認可フローで管理画面のログイン・同意を経由するため)
  • 接続元 IP を限定する場合は、[環境設定] → [管理画面] の「Admin MCP のアクセス制限(IP アドレス)」の設定
課金対象

Admin MCP(/direct/rcms_api/admin_mcp/)へのリクエストは、通常の API リクエストと同様にリクエストごとの課金対象です。


kuroco-content-structure-creation - コンテンツ定義の作成

MCP ツールによるコンテンツ定義(TopicsGroup)の作成を支援するスキルです。

機能

  • コンテンツ定義の作成手順(MCP ツール経由)
  • フィールドタイプのリファレンス(テキスト、WYSIWYG、選択、チェックボックス、画像、ファイル、関連、日付、JSON、ブロックエディタなど)
  • フィールドグループ、繰り返し項目の定義方法

使用例

「コンテンツ定義を新しく作りたい」
「拡張項目に選択式のフィールドを追加したい」
「繰り返し項目を持つコンテンツ定義を設計して」

対応するキーワード

コンテンツ定義 TopicsGroup 拡張項目 ext_col フィールドタイプ フィールドグループ 繰り返し項目


kuroco-api-performance-review - API パフォーマンス & コストレビュー

Admin MCP の読み取り系ツールで API のパフォーマンスと利用料を調査し、キャッシュ設定を中心とした改善提案をまとめるスキルです。

機能

  • 費目別のコスト内訳と推移の把握(利用状況)
  • エンドポイント別の集計分析(リクエスト数、キャッシュヒット / ミス、平均実行時間、平均レスポンスサイズ)
  • キャッシュ設定と直近実績の突き合わせ(キャッシュ期間が未設定なのか、設定済みでも当たっていないのかの切り分け)
  • 生ログによる裏取り(クローラー比率、リファラー別のリクエスト数、エラーの常態化)
  • 症状別の調査レシピと、費用対効果順の対策整理

使用例

「Kuroco の利用料が増えた原因を調べたい」
「キャッシュヒット率が低いエンドポイントを洗い出したい」
「API リクエスト課金の内訳を分析して」
「レスポンスが遅いエンドポイントを特定して」

対応するキーワード

利用料 コスト 従量課金 API リクエスト キャッシュされた API リクエスト キャッシュヒット率 MISS PASS API 解析 キャッシュ設定 maxage CDN 転送量 実行時間 クローラー

前提条件

  • Admin MCP への接続(調査のみであれば読み取り専用の権限レベルで足ります)
  • 費用の分析には利用状況を参照できる権限

kuroco-security-audit - セキュリティ設定チェック

Admin MCP の読み取り系ツールのみでセキュリティ設定を収集し、チェックリストに照らしてリスクを診断・報告する読み取り専用のスキルです。設定の変更は行いません。

機能

  • API のセキュリティ方式・CORS・IP アドレス制限の点検
  • ログイン / パスワードポリシー、2 要素認証(ワンタイムパスワード)の設定確認
  • 権限グループとスーパーユーザーの棚卸し
  • 静的アクセストークン・シークレットの棚卸し
  • 監査ログの有効性確認と、MCP で取得できない項目の手動確認リスト化

使用例

「セキュリティ設定に問題がないか確認したい」
「CORS と IP 制限の設定を点検して」
「権限グループとスーパーユーザーを棚卸ししたい」
「静的アクセストークンの棚卸しをして」

対応するキーワード

セキュリティチェック セキュリティ監査 セキュリティ診断 CORS IP 制限 アクセス制限 権限 スーパーユーザー 2 要素認証 ワンタイムパスワード パスワードポリシー 静的アクセストークン 監査ログ

脆弱性スキャンとの違い

本スキルは管理画面で設定できる項目の設定値レビューを行うもので、脆弱性スキャンやペネトレーションテストは対象外です。


関連ドキュメント


サポート

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。