# AI & Agents Source: https://docs.polastack.com/content/ai-agents/index AI エージェントからこのドキュメントを読む方法 このドキュメントサイトは、人間だけでなく **AI エージェントを一級の読者**として設計されています。 コーディングエージェントや AI アシスタントに Polastack のことを調べさせるとき、HTML をスクレイピングさせる必要はありません。 用途に応じて次の 3 つの方法を使い分けてください。 | 方法 | 用途 | 使い方 | | ------------------------------------------------- | ------------- | --------------------------------------- | | [Markdown 取得](/content/ai-agents/markdown-access) | 特定のページを読ませたい | URL の末尾に `.md` を付ける | | [llms.txt](/content/ai-agents/llms-txt) | サイト全体の地図を渡したい | `/llms.txt`(索引)または `/llms-full.txt`(全文) | | [MCP サーバ](/content/ai-agents/mcp) | エージェントに検索させたい | `https://docs.polastack.com/mcp` を登録 | いずれも認証不要で、追加のセットアップなしに今すぐ使えます。 Polastack **製品側**の AI エージェント連携(プロダクトの MCP 対応・エージェント向け API)については準備中です。 このセクションで扱うのは「このドキュメント自体を AI に読ませる方法」です。 # llms.txt — サイト全体の索引 Source: https://docs.polastack.com/content/ai-agents/llms-txt AI エージェントにドキュメント全体の地図を渡す 本サイトは [llms.txt 規約](https://llmstxt.org/)に対応しており、2 つのファイルを自動生成しています。 | ファイル | 内容 | 向いている用途 | | ------------------------------------------------------------ | ----------------------- | ----------------------- | | [`/llms.txt`](https://docs.polastack.com/llms.txt) | 全ページのタイトル・URL・説明の**索引** | エージェントが必要なページを選んで読む(推奨) | | [`/llms-full.txt`](https://docs.polastack.com/llms-full.txt) | 全ページの**全文**を 1 ファイルに連結 | コンテキストに全部載せたい小規模な調査 | ## 使い方の例 エージェントへの指示にこう書くだけです。 ```text theme={null} Polastack について調べるときは、まず https://docs.polastack.com/llms.txt を読んで必要なページを特定し、 各ページは URL 末尾に .md を付けて取得してください。 ``` 索引の各エントリは `.md` 付き URL([Markdown 取得](/content/ai-agents/markdown-access))を指しているため、 エージェントは HTML を経由せずにドキュメント全体を巡回できます。 ドキュメントが増えると `/llms-full.txt` は大きくなります。 定常的に使うエージェントには、索引(`/llms.txt`)+ 必要ページの `.md` 取得、 または [MCP サーバ](/content/ai-agents/mcp)経由の検索を推奨します。 # Markdown でページを取得する Source: https://docs.polastack.com/content/ai-agents/markdown-access URL 末尾に .md を付けるだけでクリーンな Markdown が返ります 本サイトの任意のページは、URL の末尾に `.md` を付けるとクリーンな Markdown として取得できます。 ナビゲーションやスクリプトを含む HTML と違い、本文だけが返るため、AI エージェントのコンテキストを浪費しません。 ```bash theme={null} # HTML ページ https://docs.polastack.com/content/getting-started # 同じ内容の Markdown curl https://docs.polastack.com/content/getting-started.md ``` 効果は劇的です。 例えば Getting Started ページの実測では、HTML が約 200 KB に対して Markdown は約 0.7 KB でした(約 1/300)。 ## いつ使うか * エージェントに**特定のページだけ**を正確に読ませたいとき * プロンプトにドキュメントの一部を貼り付けたいとき * 独自のインデックス(RAG 等)を構築するとき 返される Markdown の冒頭には、全ページ索引([llms.txt](/content/ai-agents/llms-txt))への案内が含まれます。 エージェントはそこから他のページを自律的に辿れます。 # MCP サーバに接続する Source: https://docs.polastack.com/content/ai-agents/mcp docs.polastack.com/mcp をエージェントに登録してドキュメントを検索させる 本サイトは [Model Context Protocol(MCP)](https://modelcontextprotocol.io/)のサーバをホストしています。 エージェントに登録すると、このドキュメントを**検索・閲覧するツール**が使えるようになります。 ```text theme={null} エンドポイント: https://docs.polastack.com/mcp トランスポート: Streamable HTTP / 認証: 不要 ``` ## Claude Code に登録する ```bash theme={null} claude mcp add --transport http polastack-docs https://docs.polastack.com/mcp ``` 登録後、「Polastack のテーブル作成方法を docs から調べて」のように指示すると、エージェントが自動でこのサーバを使います。 ## 他の MCP クライアント Streamable HTTP 対応のクライアントであれば、設定ファイルに次のように追加します(形式はクライアントのドキュメントに従ってください)。 ```json theme={null} { "mcpServers": { "polastack-docs": { "type": "http", "url": "https://docs.polastack.com/mcp" } } } ``` ## 提供されるツール | ツール | できること | | -------------------------------------- | --------------------------------------------------------------------------------------- | | `search_polastack_docs` | ドキュメント全体のキーワード検索。タイトルとページへのリンク付きで結果を返す | | `query_docs_filesystem_polastack_docs` | ドキュメントだけを収めた**読み取り専用の仮想ファイルシステム**への問い合わせ(`rg` / `head` / `cat` 相当)。検索で見つけたページの全文を読むのに使う | | `submit_feedback` | ドキュメントの誤り・分かりにくさをその場で docs チームに報告する | この MCP サーバができるのは**ドキュメントの検索・閲覧だけ**です。 Polastack 製品の API を操作したり、認証が必要な情報にアクセスすることはできません。 # API Reference Source: https://docs.polastack.com/content/api-reference/index Polastack REST API リファレンス(準備中) API Reference は OpenAPI 仕様(`api-reference/openapi-public.json`)から自動生成されます。 仕様ファイルは製品リポジトリの CI から自動 PR で届き次第、全エンドポイントのページとプレイグラウンドがここに展開されます。 # Changelog Source: https://docs.polastack.com/content/changelog/index Polastack ドキュメント・API・SDK の変更履歴 docs.polastack.com を公開しました。 コンテンツは順次拡充します。 ## このページの運用について * **API の変更**: API Reference の元になる OpenAPI 仕様はリポジトリ上で更新履歴が管理され、 変更はすべて Pull Request として記録されます。ここには重要な変更(破壊的変更・メジャーバージョン)のみ ハイライトとして掲載します * **SDK の変更**: リリースノートへのリンクで参照し、ハイライトのみここに掲載します (リンクは SDK の一般公開後に追加します) * **ドキュメント自体の変更**: 大きな構成変更があった場合に記載します # Developer Tools Source: https://docs.polastack.com/content/developer-tools/index SDK・CLI・管理ダッシュボード(準備中) TypeScript SDK・CLI・管理ダッシュボードの使い方を掲載予定です。 SDK Reference はビルド成果物(TypeDoc)から自動生成されます。 # Polastack へようこそ Source: https://docs.polastack.com/content/getting-started/index Polastack 公開開発者ドキュメント(準備中) Polastack は、SaaS 開発に必要なバックエンド機能を統合して提供するプラットフォームです。 このドキュメントサイトは現在準備中です。 クローズドベータに向けてコンテンツを整備しています。 最初のテーブル作成から API 呼び出しまでを案内する Getting Started を公開予定です。 # Guides & Patterns Source: https://docs.polastack.com/content/guides-patterns/index 実践ガイドと設計パターン(準備中) ユースケース別の実践ガイドと設計パターンを掲載予定です。 コード例はすべて `examples/` ディレクトリの実ファイルから抜粋し、CI でコンパイル検証されます。 # Integrations Source: https://docs.polastack.com/content/integrations/index 外部サービスとの連携(準備中) 外部サービスとの連携ガイドを掲載予定です。 # Migration Source: https://docs.polastack.com/content/migration/index 他プラットフォームからの移行(準備中) Firebase / Supabase からの移行ガイドを掲載予定です。 # Modules Source: https://docs.polastack.com/content/modules/index Polastack を構成するモジュールの概要(準備中) Polastack は以下のモジュールで構成されます。 各モジュールのガイドは順次公開します。 * Auth * Gateway * Database * Events * Billing * Hosting * Search * Observability * Analytics * Config as Code # Resources Source: https://docs.polastack.com/content/resources/index ソースリポジトリ・フィードバック窓口・コントリビューション ## このドキュメントについて 本サイトのソースは GitHub の公開リポジトリ [siracusa-hq/polastack-docs](https://github.com/siracusa-hq/polastack-docs) で管理されています。 main ブランチへのマージで自動デプロイされます。 ## 誤りの報告・質問 * **ドキュメントの誤り・分かりにくい箇所**: [GitHub Issues](https://github.com/siracusa-hq/polastack-docs/issues/new/choose) からご報告ください。専用のフィードバックフォームを用意しています * AI エージェント経由なら、[MCP サーバ](/content/ai-agents/mcp)の `submit_feedback` ツールでその場から報告できます ## コントリビューション 誤記の修正や説明の改善など、Pull Request を歓迎します。 1. リポジトリを fork してブランチを作成 2. `content/` 配下の MDX を編集(日本語・1文=1行を基本) 3. PR を作成 PR には表記・命名ルール(Vale)とリンク切れ検査が自動で走ります。 `api-reference/` `sdk-artifacts/` `brand/` 配下は自動生成物のため、直接の変更 PR は受け付けられません。 詳細はリポジトリの [README](https://github.com/siracusa-hq/polastack-docs#readme) を参照してください。 ## 関連サイト * [polastack.com](https://polastack.com) — Polastack 製品サイト # Security & Compliance Source: https://docs.polastack.com/content/security-compliance/index セキュリティとコンプライアンス(準備中) 認証・認可モデル、データ保護、コンプライアンスに関する情報を掲載予定です。