Typemark Documentation

エージェント対応のドキュメント

すべてのTypemarkサイトはMarkdown、llms.txt、MCPサーバーを提供しており、AIツールも人と同じようにドキュメントを読めます。

2026年11月19日更新

読者は、ドキュメントを開く前にAIアシスタントに質問することが増えています。すべてのTypemarkサイトは、すべてのプランでそれに対応しており、設定は不要です。各ページにはMarkdown版があり、サイトにはllms.txtとllms-full.txtがあります。また、MCPサーバーにより、コーディングツールがドキュメントを直接検索して読めます。

プライベートドキュメントは例外です。AIツールはサインインできないため、パスワードで保護されたサイトにはMCPサーバーがありません。そのMarkdownとllms.txtも、他のすべてと同様にパスワードが必要です。

以下の例ではhttps://docs.acme.comを使用しています。お使いのサイトのアドレス(カスタムドメインまたは{slug}.typemark.dev)に置き換えてください。

すべてのページのMarkdown版

任意のページURLの末尾に.mdを付けると、そのページをMarkdownで取得できます。

curl https://docs.acme.com/guides/authentication.md

ページのタイトルが見出しとして、説明が引用として、フロントマターを除いたページ本文が返されます。<Callout>などのコンポーネントはそのまま残り、リンクはサイトの完全なURLを指します。

Accept: text/markdownを送信するツールは、通常のページURLからMarkdownを取得します。各HTMLページは、LinkヘッダーでMarkdown版を指しています。

llms.txtとllms-full.txt

ファイル内容
/llms.txtサイト名と概要、その後に全ページの一覧(Markdown版へのリンクと説明付き)。llms.txt形式に従います。
/llms-full.txt全ページのMarkdownを、ナビゲーションの順序で1つのファイルにまとめたもの。

概要の行は、typemark.jsonのseo.default_descriptionから取得されます。フロントマターでhidden: trueが指定されたページは、両方のファイルから除外されます。

これらのファイルは最大1時間キャッシュされる場合があるため、変更が反映されるまで時間がかかることがあります。

MCPサーバー

すべてのサイトには、/mcpに読み取り専用のMCPサーバーがあります。AIツールに追加すると、作業中にツールがドキュメントを検索して読めるようになります。サインインやAPIキーは不要です。

https://docs.acme.com/mcp

ツールは3つあります。

ツール機能
search_docsドキュメントを検索し、一致するページを最大10件、それぞれ抜粋付きで返す
get_pageパスまたはURLを指定してページをMarkdownで返す
list_pagesナビゲーションの順序で全ページを、パスと説明付きで一覧表示する

ツールを接続する

~/.cursor/mcp.json、またはプロジェクト内の.cursor/mcp.jsonに以下を追加します。

{
  "mcpServers": {
    "acme-docs": {
      "url": "https://docs.acme.com/mcp"
    }
  }
}

ワークスペース内の.vscode/mcp.jsonに以下を追加します。

{
  "servers": {
    "acme-docs": {
      "type": "http",
      "url": "https://docs.acme.com/mcp"
    }
  }
}

ターミナルで以下を実行します。

claude mcp add --transport http acme-docs https://docs.acme.com/mcp

ClaudeでCustomize > Connectorsを開き、Add custom connectorを選択して、サーバーのURLを貼り付けます。

読者がこの設定を自分で書く必要はありません。ページのアクションメニューにあるConnect to Cursor / VS Code / Claudeをクリックすると、サイトのURLが入力された設定スニペットが表示されます。

制限

各IPアドレスは1分あたり60件のMCPリクエストを送信でき、各サイトは1分あたり最大600件を処理します。

ページアクション

公開済みのすべてのページには、タイトルの横にCopy pageボタンがあり、AIアクションのメニューが付いています。

アクション機能
Copy pageページをMarkdownでコピーし、チャットに貼り付けられる状態にする
View as Markdownページの.md版を開く
Open in ChatGPTページを読み込んだChatGPTのチャットを開始する
Open in Claudeページを読み込んだClaudeのチャットを開始する
Connect to Cursor / VS Code / ClaudeサイトのMCP設定を表示する

目次の下にあるUse these docs with AIカードには、Connect via MCPとCopy llms.txt linkがあります。

ページアクションはデフォルトで有効です。ボタン、メニュー、カードを非表示にするには、Settings > Reader featuresでPage actionsをオフにするか、typemark.jsonに以下を設定します。

"features": {
  "page_actions": false
}

ページアクションをオフにしても、読者からの表示が隠れるだけです。Markdownページ、llms.txt、MCPサーバーは引き続き利用できます。

エージェントに見えるもの

AIツールには、読者が見るものとまったく同じものが提供されます。

  • 公開済みの内容のみ。 手動デプロイモードでは、未公開の編集はMarkdownページ、llms.txt、MCPに含まれません。
  • オフライン時は何も提供しない。 サイトがオフラインの場合、これらの経路はコンテンツを提供しません。
  • 非表示のページは一覧に載らない。 hidden: trueのページはllms.txt、llms-full.txt、MCPサーバーの検索とページ一覧から除外されます。そのMarkdown版にはnoindexが付けられます。
  • デフォルト言語。 複数言語のサイトでは、llms.txt、llms-full.txt、MCPサーバーはデフォルト言語を提供します。
  • プレビューなし。 プレビューデプロイとブランチプレビューには、Markdownページ、llms.txt、MCPサーバーはありません。