mcpField
L
llms.txt

llms.txt

ローカル
basitalisandhu.github.io開発ツール12 日前に更新

llms.txt について

llms.txtは、ローカルのMarkdownやsitemap.xmlからllms.txtを生成し、内容を検査するMCPサーバーです。URLの取得やファイルへの書き込みを行わず、開発者が規約に沿ったインデックスを準備できます。

主な機能

  1. 01ローカルのMarkdownから生成
  2. 02サイトマップから項目を生成
  3. 03llms.txtの形式と構成を検査
  4. 04スキップしたファイルと検査結果を返却

活用シーン

  1. 01プロジェクト文書からインデックスを作成
  2. 02ローカルのサイトマップから項目を作成
  3. 03公開前に既存のllms.txtを検査

MCP 対応

MCPクライアントにllms.txtの生成・検査ツールを提供します。ローカルファイルのみを読み取り、生成したテキストは書き込まずに返します。

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定
{
"mcpServers": {
"basitalisandhu-mcp-llms-txt": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/basitalisandhu/mcp-llms-txt:0.3.0"
]
}
}
}
起動コマンドdocker run -i --rm ghcr.io/basitalisandhu/mcp-llms-txt:0.3.0

ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ
ocighcr.io/basitalisandhu/mcp-llms-txt:0.3.0

ツール

ツール一覧はまだ取得されていません

ローカルサーバーのツールはマシン上で起動して初めて取得できます。メンテナーはまだツール一覧を提供していません。

詳細

llms-txt MCP サーバー

Markdown ディレクトリまたはローカルの sitemap.xml から llms.txt を生成し、既存の llms.txt が規約に準拠しているかを確認します。ローカルファイルのみを読み取り、ファイルへの書き込みや URL の取得は行いません。

dev-mcp-servers の一部です。トランスポートは Stdio のみで、サーバーがポートを開くことはありません。

ツール

ツール入力返される内容
generate_llms_txtdirectory、title、description?、details?、base_url?、url_style?、max_files?、include_dirs?、optional_sections?.md、.mdx、.markdown ファイルをスキャンします(node_modules、.git、ビルド出力、非表示ディレクトリは除外)。タイトルにはフロントマター、最初の H1、またはファイル名を使用し、説明にはフロントマターまたは最初の段落を使用します。最上位のフォルダーごとに分類し、テキスト、エントリー、スキップされた項目を返します。
generate_from_sitemappath、title、description?、details?、include_prefix?、exclude_prefix?、optional_sections?、max_urls?<url> ごとに 1 つのリンクを生成し、最初のパスセグメントごとに分類します。タイトルは URL から生成されます(ページは取得されません)。
check_llms_txtpath または content行番号付きのエラー、警告、情報を返します。先頭に H1 が 1 つあること、要約のブロック引用、- [name](url): notes 形式の H2 セクション、それより深い見出しがないこと、重複がないこと、適度なサイズであることを確認します。

インストール

Claude Code:

claude mcp add llms-txt -- docker run --rm -i -v "$PWD:/work:ro" ghcr.io/basitalisandhu/mcp-llms-txt:0.2.2

すべてのプロジェクトで使用できるようにするには、-s user を追加します。.mcp.json を読み取るクライアント(Claude Code、Claude Desktop、Cursor)では、次のようにします。

{
  "mcpServers": {
    "llms-txt": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "-v", "/path/to/your/project:/work:ro", "ghcr.io/basitalisandhu/mcp-llms-txt:0.2.2"]
    }
  }
}

バージョンを示されているとおりに固定してください。そうすれば、気付かないうちに更新によってエディターで実行される内容が変わることを防げます。コンテナーから見えるのはマウントされたディレクトリのみなので、/work 配下のパスを指定してください。パッケージはまだ npmjs.com に登録されていないため、npx は動作しません。GitHub Packages の npm についてはリポジトリの READMEを参照してください。チェックアウトしたリポジトリでは、ルートで npm install && npm run build を実行した後、"command": "node", "args": ["<path>/packages/llms-txt/dist/index.js"] を使用してください。

変更するもの

  • ネットワーク:使用しません。
  • ローカルファイル:指定したディレクトリ配下の Markdown ファイル(最大 1000 ファイル、各 1 MB、深さ 12 階層まで)、または指定した 1 つの sitemap か llms.txt(最大 2 MB)を読み取ります。
  • テレメトリー:ありません。

補足

  • 出力はテキストとして返されます。確認した後、ご自身で llms.txt に書き込んでください。
  • sitemap から生成したファイルの説明は、ページの内容を取得しないため空です。公開前に入力してください。

ビルドとテスト

npm install        # at the repository root
npm run build -w @basitalisandhu/mcp-llms-txt
npm test -w @basitalisandhu/mcp-llms-txt

テストには node:test と SDK のインメモリトランスポートを使用し、ネットワークには接続しません。

ライセンス

MIT。LICENSEを参照してください。

コメント

MCP は初めてですか?

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。