mcpField
L
llms.txt

llms.txt

本地服务
basitalisandhu.github.io开发工具12 天前更新

关于 llms.txt

llms.txt 是一个 MCP 服务,可从本地 Markdown 或 sitemap.xml 生成并检查 llms.txt 文件。它帮助开发者准备符合约定的索引,不会获取 URL 或写入文件。

主要功能

  1. 01从本地 Markdown 生成
  2. 02从 sitemap 生成条目
  3. 03检查 llms.txt 格式与结构
  4. 04返回跳过的文件和检查结果

适用场景

  1. 01从项目文档创建索引
  2. 02根据本地 sitemap 构建条目
  3. 03发布前检查现有 llms.txt

MCP 相关

该 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、构建输出目录和隐藏目录),从 frontmatter、首个 H1 或文件名中提取每个标题,从 frontmatter 或首段提取备注,按顶层文件夹分组,并返回文本、条目及所有跳过的内容。
generate_from_sitemappath、title、description?、details?、include_prefix?、exclude_prefix?、optional_sections?、max_urls?每个 <url> 生成一个链接,按首个路径段分组,根据 URL 生成标题(不会获取页面内容)。
check_llms_txtpath 或 content返回带行号的错误、警告和提示:首行为单个 H1、使用块引用作为摘要、使用 - [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 不可用;请参阅代码库 README,了解 GitHub Packages npm 的用法。从代码库检出版本进行安装时,在代码库根目录运行 npm install && npm run build 后,使用 "command": "node", "args": ["<path>/packages/llms-txt/dist/index.js"]。

访问内容

  • 网络:无。
  • 本地文件:读取你指定目录下的 Markdown 文件(最多 1000 个文件,每个文件 1 MB,最多深入 12 层),或读取你指定的一个 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。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。