> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/ja-gitbook-documentation/docs-as-code/ai-coding-assistants-and-skillmd.md). # エージェントスキル GitBook の公式 SKILL.md ファイルを使って、Claude Code、Cursor、Codex などの AI コーディングアシスタントに GitBook の機能やブロックの知識を与えます GitBookは提供しています [スキルファイル](https://github.com/GitbookIO/gitbook-skills/tree/main) AIコーディングアシスタントに、GitBookのドキュメントを正しく編集する方法を教えるものです。Claude Code、Cursor、Codex、または別の外部コーディングアシスタントを使っている場合は、GitBookスキルを追加して、エージェントがGitBookの構文、ブロック、設定ファイルを扱えるようにしてください。 これは次と相性が良いです [Git Sync](/docs/documentation/ja-gitbook-documentation/docs-as-code/git-sync.md) のワークフローです — リポジトリで変更を加え、コミットすると、ドキュメントサイトが自動で更新されます。 {% hint style="info" %} GitBookエディタで書くほうがよいですか？ [GitBook Agent](/docs/documentation/ja-gitbook-documentation/gitbook-jento/overview.md) を使えば、GitBookを離れずに下書き、書き直し、レビュー、翻訳ができます。 {% endhint %} ## AIエージェントにGitBookスキルを追加する AIコーディングアシスタントがパッケージベースのスキルをサポートしている場合にこのオプションを使用します。 {% stepper %} {% step %} ### アクセストークンを作成する エージェントがGitBookとやり取りできるようにするには、 [アクセストークンを作成する](https://app.gitbook.com/account/developer) GitBookの開発者設定から作成する必要があります。GitBookは、このトークンをGitBookスキルで作業する際のエージェント認証に使用します。 {% endstep %} {% step %} ### GitBookスキルをインストールする このスキルは次のリポジトリの一部です [`gitbook-skills`](https://github.com/GitbookIO/gitbook-skills) リポジトリ。次のコマンドを実行して、GitBookスキルをプロジェクトに直接インストールします： {% code expandable="true" %} ```bash npx skills add GitBookIO/gitbook-skills ``` {% endcode %} {% endstep %} {% endstepper %} ## GitBookスキルをローカルに追加する アシスタントがパッケージベースのスキルをサポートしていない場合は、GitBookのスキルをダウンロードしてください。 {% stepper %} {% step %} ### アクセストークンを作成する エージェントがGitBookとやり取りできるようにするには、 [アクセストークンを作成する](https://app.gitbook.com/account/developer) GitBookの開発者設定から作成する必要があります。GitBookは、このトークンをGitBookスキルで作業する際のエージェント認証に使用します。 {% endstep %} {% step %} ### GitBookスキルをダウンロードする GitBookスキルを次でインストールする `npx skills add GitBookIO/gitbook-skills` アシスタントが対応している場合。 ファイルを手動でプロジェクトにコピーするには、次の場所からGitBookスキルを入手してください： [`gitbook-skills`](https://github.com/GitbookIO/gitbook-skills) リポジトリ。
スキル説明ダウンロード
configure-siteGitBookドキュメントサイト全体を作成し、維持します。GitHub
write-docsGitBookのドキュメントページを執筆、作成、編集、整形します。GitHub
write-openapiOpenAPI/SwaggerのAPIリファレンスドキュメントを作成、設定、構成し、トラブルシュートします。GitHub
build-integrationGitBook向けのカスタム統合を構築します。GitHub
cr-createGitBookの変更リクエストを作成し、コンテンツをプッシュし、レビューを依頼し、コメントに対応します。GitHub
cr-reviewGitBookの変更リクエストをレビューし、変更点を要約し、コメントし、承認するか、変更を依頼します。GitHub
{% hint style="warning" %} ローカルリポジトリを最新の `SKILL.md` ファイルに更新することを忘れないでください。GitBookに新機能が追加されるたびに更新してください。 {% endhint %} {% endstep %} {% endstepper %} ## GitBookスキルの使用 {% prompt description="Scaffold a Git-synced docs site from a folder of markdown" %} ```markdown GitBookスキルを使って、このMarkdownフォルダをGit Syncで管理されるGitBookドキュメントサイトに変換してください。 1. ドキュメントフォルダを読み取り、サイト構成案を提案してください — スペース、ページツリー、SUMMARY.mdナビゲーション。何も書く前に見せてください。 2. リポジトリをGitBookのモノレポ構成（各スペースごとにREADME.md + SUMMARY.md）で作成し、コミットしてください。 3. サイトとスペースを作成し、その後、GitBook UIで私が行う1つの手順 — 各スペースをGit Syncでそれぞれのディレクトリに接続する作業 — について、正確にそのまま貼り付けられる手順を教えてください。 4. 同期の設定が完了したら、サイト構成が計画どおりか確認してください。 ``` {% endprompt %} {% prompt description="Upgrade a plain markdown page into a polished GitBook page" %} ```markdown GitBookスキルを使って、このページをGitBookのリッチブロックで書き直してください — 現在は通常のMarkdownです。 1. ページを読んで、何を改善すべきか教えてください：複数言語のコードサンプル → タブ、順序付きの手順説明 → ステッパー、注意書き → ヒント、「選択してください」系の内容 → カード。 2. frontmatter（title、description、icon）を含め、正しいGitBook構文で変更を適用してください。 3. 表現はそのままにしてください — 口調ではなく構成を改善してください。 4. GitBookでレンダリングされた後に私が再確認すべき点をすべて挙げてください。 ``` {% endprompt %} {% prompt description="Generate an API reference from an OpenAPI spec" %} ```markdown GitBookスキルを使って、OpenAPI仕様からドキュメント内にAPIリファレンスセクションをセットアップしてください。 1. 仕様を見つけるか、存在しない場合はコードベースから生成するのを手伝って、それを検証してください。 2. SUMMARY.mdでGitBookのOpenAPIブロックを使って自動生成されるエンドポイントページを設定してください — エンドポイントページは手書きしないでください。仕様を唯一の正しい情報源として維持します。 3. 各リソースグループごとに短い概要ページを追加してください。 4. 表示されるリファレンスを弱くする仕様の不足（説明、例、レスポンススキーマの欠落）を指摘してください。 ``` {% endprompt %} ## よくある質問
SKILL.mdには何が含まれていますか？ `SKILL.md` AIコーディングアシスタントがGitBookコンテンツを正しく作成、編集、整形するために必要なコンテキストを与えます。 含まれる内容： * カスタムブロック用の完全な構文リファレンス。 * 設定ファイル形式。含まれるもの： `.gitbook.yaml`, `SUMMARY.md`を読み取り、 `.gitbook/vars.yaml`. * frontmatterオプション、レイアウト制御、変数、式、決定表、およびよくある落とし穴。
AI生成コンテンツをどうテストしますか？ AIアシスタントが生成したコンテンツは、必ずレビューしてテストしてください。スキルファイルで学習したアシスタントを使う場合： * カスタムブロックがGitBookで正しくレンダリングされることを確認します。 * すべての内部リンクが機能することを確認します。 * frontmatterが有効なYAMLであることを確認します。 * 変数が正しいスコープを参照していることをテストします。
アシスタントがSKILL.mdを使っているかどうかはどう確認しますか？ GitBookページをどのように整形するか説明させてください。 GitBookブロック、frontmatter、変数、または次のようなファイルに言及するなら `SUMMARY.md`、スキルは読み込まれています。 一般的なMarkdownだけで答える場合は、プロジェクトルールを確認してアシスタントを再読み込みしてください。
アシスタントがGitBook固有の構文を無視するのはなぜですか？ これは通常、スキルファイルが読み込まれていないか、ルールが十分に具体的でないことを意味します。 アシスタントが次を読み込んでいることを確認してください `SKILL.md` をリポジトリのルートから、またはプロジェクト指示内のGitHub URLを使って読み込むようにしてください。 アシスタントが指示をキャッシュする場合は、ルールを追加または更新した後にセッションを再起動してください。
アシスタントが無効なGitBookコンテンツを生成したらどうしますか？ まず一般的な失敗箇所を確認してください： * 閉じられていないカスタムブロック * frontmatter内の無効なYAML * 壊れた変数参照 * ページ構造と一致しないリンク コミットする前に、必ずGitBookで出力をレビューしてください。
それでもアクセストークンは必要ですか？ エージェントがGitBookと直接やり取りする場合は、アクセストークンが必要です。あなたの [開発者設定](https://app.gitbook.com/account/developer). を使ってローカルでファイルを編集しているだけなら `SKILL.md`、アシスタントをGitBookのワークフローやAPIに接続するまで不要な場合があります。
スキルが古く見える場合はどうしますか？ ローカルの `SKILL.md`を更新するか、アシスタントをGitHubのソースに戻してください。 チームがファイルの一部をカスタムルールにコピーしている場合は、それらも更新してください。
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://gitbook.com/docs/documentation/ja-gitbook-documentation/docs-as-code/ai-coding-assistants-and-skillmd.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.