Skip to content
cccskills
FreePublished on GitHub

microcms-docs

microCMSの公式開発者ドキュメント(document.microcms.io)を取得し、API仕様・制限・認証・クエリ・管理画面の操作手順を出典付きで確認する。最新の仕様確認や公式資料・コード例の参照が必要な場合に使用する。

プロジェクトの設計・実装・改善はmicrocms-guide、Next.js固有の実装はmicrocms-nextjsを優先し、必要な仕様確認をこのSkillで補う。

The English summary is being prepared. Showing the original description.

See how to install

Files included (2)

  • SKILL.md7.5 KB
  • references/urls.md13.7 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

microCMS ドキュメント参照スキル

概要

microCMS公式開発者ドキュメント document.microcms.io に対し、ユーザーの質問に応じた適切なページを特定し、Web取得ツールで内容を取得して回答する。記憶や推測ではなく、常に最新のドキュメントを根拠とする。

他のSkillとの使い分け

公式情報の取得と根拠の確認を担当する。設計・実装・改善を進める依頼では、利用可能なら microcms-guide または microcms-nextjs を使い、必要な仕様確認だけをこのSkillで補う。別Skillが未導入でも資料参照を続ける。Skill名の記載だけで別Skillが自動的に読み込まれるとは想定しない。

ワークフロー

1. 質問の分類

ユーザーの質問が次のどのカテゴリに該当するかを判断する:

カテゴリ想定される質問
コンテンツAPIデータ取得/登録、クエリパラメータ、APIキー、エラー対応
マネジメントAPIコンテンツの管理操作、メディア操作、メンバー取得
画像APIリサイズ、フォーマット変換、ウォーターマーク
操作マニュアル管理画面の使い方、フィールド設定、Webhook設定、権限
チュートリアルNext.js/Nuxt/Astro等のフレームワーク統合
SDK各言語SDKの使い方、コード例

複数カテゴリにまたがる場合(例: 「Next.jsで下書きプレビューを実装する」)は、関連する全カテゴリのURLを参照する。

2. URLの特定

references/urls.md を読み、関連URLを特定する。URLを推測で生成してはならない。

urls.md に該当ページが無い場合は、公式のページ一覧 https://document.microcms.io/llms.txt を取得して探す。全ページのタイトルとMarkdown版URLが列挙されているため、urls.md の記載が古い場合でもここから正しいURLを特定できる。

llms.txt にも該当が無ければ、そのページは存在しない。パスを組み立てて試すのではなく、「ドキュメントに該当ページが見つからない」ことをユーザーに伝える。

3. ドキュメントの取得

特定したURLの末尾に .md を付与して取得する。取得には、利用中のエージェントが持つWeb取得の手段(Web取得ツール、curl など)を使う。.md 付きでアクセスすると text/markdown 形式で本文が返るため、HTMLパース不要でLLMが扱いやすい。

例:

  • HTML版: https://document.microcms.io/content-api/get-list-contents
  • Markdown版(こちらを使う): https://document.microcms.io/content-api/get-list-contents.md

複数URLが必要な場合は、可能な限りまとめて取得する(並列取得に対応した環境では並列で取得する)。

[!IMPORTANT] 存在しないパスでも 404 ではなく 200 で HTML が返ることがある。取得結果が Markdown 本文ではなく HTML だった場合、そのURLは無効と判断する。内容を推測で補ってはならない。 その場合は https://document.microcms.io/llms.txt を取得し、正しいURLを探し直す(ページがリネームされ urls.md の記載が古くなっている可能性がある)。 セクションのトップURL(/tutorial/next/ など)は .md に対応していないため、urls.md に列挙された実ページのURLを使う。

取得時は、そのページから何を読み取りたいのかを明確にしてから読む:

  • コード例が欲しい場合: コード例(特に該当箇所)を抽出する
  • 仕様確認: パラメータ仕様、デフォルト値、必須/任意を一覧化する
  • 手順確認: 目的の操作を行うための手順を順番に抽出する

4. 回答の生成

取得した内容に基づいて回答する。以下を遵守する:

  • 出典URL を必ず明示する(複数あれば全て)
  • コード例はドキュメントの内容に基づき、不足部分のみ補完する
  • ドキュメントに記載がない事項は「ドキュメントに明示されていない」と明確に伝える
  • 古い情報(例: 旧APIキー方式)と新しい情報(X-MICROCMS-API-KEY)が混在する場合は、新しい方を推奨し旧方式の存在に触れる

重要な注意事項

  1. URLは必ず references/urls.md から確認。/manual/foo のようなパスを記憶や類推で組み立てない。
  2. 取得時はURL末尾に .md を付与する。Markdown形式で本文が返り、HTML版より精度・効率が向上する。
  3. ベースURLは https://document.microcms.io。docs.microcms.io や microcms.com/docs 等の類似URLは存在しない(誤記の可能性)。
  4. APIエンドポイント: コンテンツAPIは https://{service-id}.microcms.io/api/v1/{endpoint}、マネジメントAPIは https://{service-id}.microcms-management.io/api/v1/。
  5. 認証: 現行は X-MICROCMS-API-KEY ヘッダー。旧 X-API-KEY は非推奨。
  6. 言語: ドキュメントは日本語版が主。英語版が必要な場合のみ、パス先頭に /en を付ける(例: /en/content-api/introduction.md)。
  7. チュートリアルの対応範囲: Next.js / Astro / Nuxt 2 / Gatsby / JavaScript / PHP / Ruby / Go の8種類のみ。Remix / Nuxt 3 / iOS / Android のチュートリアルページは存在しないため、質問された場合はその旨を伝え、コンテンツAPIの仕様や各SDKのリポジトリを案内する。

ユーザーへの確認

以下のような場面ではユーザーに確認し、判断を仰ぐ:

  • 質問が曖昧で複数のカテゴリに該当しうる場合(例: 「画像を扱いたい」→ 画像API or 画像フィールド or メディア管理?)
  • 利用フレームワーク/SDKが特定できず、複数のチュートリアルから選ぶ必要がある場合
  • 提示する情報量や形式に選択肢がある場合(コード例のみ/詳細解説込みなど)

リソース

  • references/urls.md: 主要URL一覧(カテゴリ別、簡易説明付き)とクエリパラメータ早見表。まずこれを参照する。
  • https://document.microcms.io/llms.txt: 公式が提供する全ページ一覧(約13KB)。urls.md で見つからないとき、または取得結果がMarkdownでなかったときのフォールバックとして取得する。

[!CAUTION] https://document.microcms.io/llms-full.txt は全ページの本文を結合したファイルで 750KB 以上ある。取得してはならない。 llms.txt の取得に失敗した場合は urls.md の情報だけで回答を続ける。

関連

公式が microcms-document-mcp-server を提供している(/mcp-server/microcms-document-mcp-server)。利用可能な環境では併用するとさらに効率的。

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

microCMSの設計・実装・改善を公式情報に基づいて支援する。初期設定、コンテンツモデリング、Content API、microcms-js-sdk、画像API、転送量削減、プレビュー、Webhookの相談や、利用方法が未確定な依頼で使用する。Next.js固有のルーティング・キャッシュ実装はmicrocms-nextjsを優先する。

The English summary is being prepared. Showing the original description.

microcmsio/skills7Updated Sep 11, 2026

Next.jsとmicroCMSの連携を公式情報に基づいて実装・改善する。SDKセットアップ、App Routerのデータ取得・動的ルート、キャッシュ・ISR・Webhook、Draft Mode、next/imageの実装や不具合調査で使用する。フレームワーク非依存のAPI仕様・コンテンツ設計のみの相談はmicrocms-guideを優先する。

The English summary is being prepared. Showing the original description.

microcmsio/skills7Updated Sep 11, 2026

See all skills by microcmsio

Report a problem with this skill