Kuroco Skills リファレンス
このページでは、Kuroco Skills に含まれる 5 つのスキルについて詳しく説明します。
kuroco-docs - ドキュメント検索
Kuroco 公式ドキュメントの検索・参照を支援するスキルです。
機能
- プラグインに同梱された公式ドキュメントの横断検索
- 目的別クイックリファレンス(API、認証、フロントエンド、コンテンツ管理など)
使用例
「Kuroco のエンドポイント設定方法を知りたい」
「ログイン API の仕様を調べたい」
「フィルタークエリの書き方を教えて」
同梱ドキュメントの構成
| ディレクトリ | 内容 |
|---|---|
tutorials/ | 機能の使い方、実装手順、サンプルコード |
reference/ | API 設定項目、Smarty プラグイン、フィルタークエリ |
management/ | 管理画面の各機能の詳細説明 |
faq/ | よくある質問と回答 |
about/ | Kuroco の概要、料金プラン、制限事項、用語集 |
troubleshooting/ | エラー解決、問題診断ガイド |
information/ | お知らせ、リリース情報 |
update/ | アップデート情報 |
kuroco-api-content - API 連携 & コンテンツ管理
Kuroco API の設計・実装およびコンテンツ管理(CRUD 操作)に関するベストプラクティスを提供するスキルです。
旧 kuroco-api-integration と kuroco-content-management を統合したスキルです。
機能
API 連携:
- エンドポイント設計パターン(URL 構造、主要モデル、オペレーション)
- 3 つの認証方式(Cookie 認証 / トークン認証 / StaticToken 認証)
- CORS 設定、キャッシュ戦略、流量制限
- エラーハンドリングパターン
コンテンツ管理:
- コンテンツ構造(Topics / TopicsGroup / TopicsCategory)
- 拡張項目(カスタムフィールド)の設定・利用方法
- Topics API のオペレーション(list / details / insert / update / delete / bulk_upsert)
- フィルタークエリの構文と使い方
- ファイルアップロード、CSV インポート/エクスポート
使用例
「Kuroco の API でログインを実装したい」
「トークン認証の使い方を教えて」
「CORS のエラーが出る。設定方法は?」
「Kuroco でコンテンツ定義を作りたい」
「記事の一覧を API で取得したい」
「フィルターで特定カテゴリの記事だけ取得したい」
対応するキーワード
Kuroco API エンドポイント設定 認証 CORS Cookie認証 トークン認証 StaticToken JWT 流量制限 credentials include 401エラー 403エラー 429エラー pageInfo ページネーション コンテンツ定義 Topics カテゴリ WYSIWYG ファイルアップロード CSVインポート ext_col filter order_by bulk_upsert topics_flg 拡張項目
主な認証方式の比較
| 認証方式 | 推奨ユースケース | 特徴 |
|---|---|---|
| Cookie 認証 | Web アプリ | セッションベース。credentials: 'include' が必須 |
| トークン認証 | モバイルアプリ | JWT ベース。ヘッダーにトークンを付与 |
| StaticToken 認証 | サーバー間通信 | 固定トークン。管理画面で設定 |
フィルタークエリの基本構文
| 演算子 | 例 |
|---|---|
=, != | filter=category_id = 1 |
>, >=, <, <= | filter=ymd >= '2024-01-01' |
contains | filter=subject contains 'キーワード' |
in, not_in | filter=category_id in [1, 2, 3] |
kuroco-frontend-integration - フロントエンド統合 & AI 自動デプロイ
Kuroco と Nuxt.js / Next.js の統合パターンおよび AI 自動デプロイワークフローを提供するスキルです。
旧 kuroco-ai-deployment の機能を統合しています。
実践的なチュートリアルは Kuroco サンプルサイトチュートリアル を参照してください。
機能
フロントエンド統合:
- Nuxt 3 / Nuxt 2 / Next.js(App Router / Pages Router)の統合パターン
- 環境変数設定、プロジェクト構成例
- 認証実装(ログイン / ログアウト / ログイン状態確認 / 会員登録)
- SSG / SSR 設定
- KurocoPages との連携
- サードパーティ Cookie 問題への対応
AI 自動デプロイ:
- デプロイワークフロー(サイト登録 → ビルド → アップロード → デプロイ)
- 署名付き URL を使った一時ファイルアップロード
- プレビューデプロイ / 本番デプロイ
- フレームワーク自動検出(Nuxt / Next.js / Vite)
使用例
「Nuxt3 で Kuroco のコンテンツを表示したい」
「Next.js で Kuroco の認証を実装したい」
「SSG で静的サイトを生成したい」
「Safari でログインできない(Cookie の問題)」
「Kuroco のサイトを自動デプロイしたい」
「プレビュー環境にデプロイして確認したい」
対応するキーワード
Nuxt3 Next.js App Router SSG SSR useAsyncData $fetch composable useAuth KurocoPages credentials include サードパーティCookie AI自動デプロイ add_site temp-upload presigned URL kuroco_front/deploy artifact_url stage_url CI/CD
フレームワーク別の推奨
| フレームワーク | 推奨ユースケース |
|---|---|
| Nuxt.js 3.x | 新規 Vue プロジェクト(推奨) |
| Nuxt.js 2.x | 既存 Vue プロジェクト |
| Next.js 13+(App Router) | 新規 React プロジェクト |
| Next.js(Pages Router) | 既存 React プロジェクト |
デプロイワークフロー
1. サイト登録 → mng_api (add_site)
2. フロントビルド → npm run build / nuxt generate
3. アップロード → 署名付き URL → S3
4. デプロイ実行 → mng_api (KurocoFront deploy)
5. 完了 → stage_url(プレビュー) or production_url
kuroco-server-processing - Smarty プラグイン & バッチ処理
Kuroco の Smarty テンプレートの完全リファレンスおよびバッチ処理・Webhook・トリガーを使った自動化パターンを提供するスキルです。
旧 kuroco-smarty-plugins と kuroco-webhook-processing を統合したスキルです。
機能
Smarty プラグインリファレンス:
- 206 個のプラグインの完全なリファレンス
- カテゴリ別索引(API / 文字列 / 配列 / フォーム / 認証 / 外部連携 / ファイル / Vue.js)
- Smarty 基本構文(変数代入、ループ、条件分岐、修飾子)
- セキュリティ設定(IF_FUNCS / MODIFIER_FUNCS)
バッチ処理 & Webhook:
- バッチ処理の設定方法と実行頻度
- 内部 API 呼び出し(
api_internal) - 外部 API 呼び出し(
api_request) - トリガー処理(コンテンツ更新時 / フォーム送信時)
- 外部サービス連携(Slack / メール / 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通知 GitHub Actions api_request トリガー カスタム処理
カテゴリ別リファレンス
| カテゴリ | 主なプラグイン |
|---|---|
| API・データ取得 | api_internal, assign_topics_list, assign_tag_list |
| 文字列処理 | escape, truncate, date_format, translate |
| 配列操作 | count, in_array, implode, explode |
| フォーム・UI | fileupload, 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-mng-api-browser - 管理 API 操作
Kuroco の管理 API(mng_api)をブラウザ経由で操作するスキルです。 Claude Code の Claude in Chrome 拡張機能と連携します。
機能
- mng_api の 4 つのモード(whoami / discover / schema / execute)
- ブラウザのセッション Cookie を利用した認証
- API 探索(discover モード / llms.txt)
- 管理画面の UI 操作(ナビゲーション、フォーム入力)
使用例
「管理画面からコンテンツを作成して」
「このサイトのコンテンツ定義一覧を確認したい」
「管理 API でメンバー情報を取得したい」
「管理画面を自動操作してデータを入力したい」
対応するキーワード
mng_api 管理API 管理画面操作 ブラウザ自動化 discover llms.txt Topics作成 Member登録
前提条件
- Claude in Chrome MCP がインストール済みであること
- Kuroco 管理画面にログイン済みであること
mng_api のモード
| モード | 説明 | 用途 |
|---|---|---|
whoami | セッション情報の取得 | 認証確認、ログインユーザーの権限情報取得 |
discover | 利用可能なモデル・メソッドの探索 | API 構造の把握 |
schema | リクエスト・レスポンススキーマ取得 | パラメータ仕様の確認 |
execute | API の実行 | データの取得・作成・更新・削除 |
セキュリティ上の注意事項
- Cookie 値を表示・ログ出力しない
document.cookieでのトークン抽出は禁止- 変更操作(insert / update / delete)は実行前にユーザーに確認
- API レスポンスのファイル保存はユーザー同意が必要
関連ドキュメント
- Kuroco Skills の使い方 - インストール方法と基本的な使い方
- Kuroco Skills GitHub リポジトリ
サポート
お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。