AIを活用してReadMeのドキュメント構成を監査する方法

ReadMe MCPを使用して、AIがカテゴリ一覧やページの階層構造を取得します。取得した構造を要件と比較することで、情報の欠落、リンク切れ、または廃止すべきコンテンツを特定します。現状の把握から修正が必要な箇所の洗い出しまで、一連のプロセスを可視化できます。

1. 01

   ツリーのマップ作成

   エージェントがドキュメント内のすべてのトップレベルおよびネストされたカテゴリを特定します。

   list_categories
2. 02

   カテゴリの調査

   特定のカテゴリ内部を確認し、どのように構成されているかを把握します。

   get_category
3. 03

   カスタムページの検索

   標準的なカテゴリ構造の外にあるカスタムページをAIが探し出します。

   list_custom_pages
4. 04

   ページ内容の監査

   カテゴリ内の具体的なドキュメントを取得し、情報の深さや関連性をチェックします。

   get_category_docs

ReadMe Connector

準備完了です。MCPクライアントを選択し、セットアップ手順に従ってください。

コネクタリンクhttps://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcpコピー

Claude Desktop

以下の手順で数秒で接続できます。

1. 1In Claude Desktop, open Settings → Connectors.
2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
3. 3Click Add and start a new chat — ReadMe capabilities are ready to use.

設定 · claude_desktop_config.jsonコピー

{
  "mcpServers": {
    "readme-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp"
    }
  }
}

• Claude
• ChatGPT
• Cursor
• VS Code
• Windsurf
• Claude Code
• JetBrains
• Cline

VinkiusにReadMeアカウントを連携させるだけです。認証情報は暗号化されて保護されるため、お使いのAIクライアントからすぐにドキュメントに関する質問を開始できます。

• 01

  AIはドキュメントのページを編集できますか？

  いいえ。AIができるのは構造とコンテンツの読み取りのみです。編集を行う場合は、ReadMe上で手動で行う必要があります。

• 02

  AIが古いコンテンツを削除してくれますか？

  いいえ。AIは削除すべき箇所を特定することはできますが、ページを削除する権限は持っていません。

• 03

  AIは非公開のドキュメントまで閲覧しますか？

  はい。AIは、使用しているReadMe APIの認証情報がアクセス権を持っているドキュメントのみを閲覧できます。

• 04

  ページが古いかどうかをAIはどうやって判断しますか？

  AIは読み取ったコンテンツを、プロンプトで指定した指示やパターンと比較して判断します。

• 05

  特定のサブカテゴリだけを監査することはできますか？

  はい。特定のカテゴリや、特定のカスタムページ群に絞って調査するようAIに指示できます。

• ReadMeに関するその他の質問 ReadMeコネクターの全機能を見る