LLMS.txt Explorer Server 使用说明

项目简介

LLMS.txt Explorer Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在帮助用户发现和分析实现了 'llms.txt' 标准的网站。'llms.txt' 是一种网络标准,网站可以通过它声明其与大型语言模型(LLM)的交互策略。此服务器提供资源浏览和工具调用能力,使 LLM 应用能够查询和利用这些策略信息。

主要功能点

  • 资源浏览:
    • 网站列表: 提供预定义的 'llms.txt' 网站列表,方便用户发现和浏览。
    • 网站详情: 可以读取特定网站的详细信息,包括其 'llms.txt' 和 'llms-full.txt' 文件的内容及相关链接。
  • 工具调用:
    • 检查网站 (check_website): 允许用户输入网址,服务器将检查该网站是否包含 'llms.txt' 和 'llms-full.txt' 文件,并返回文件的URL、内容以及验证状态。
    • 列出网站 (list_websites): 允许用户列出已知的 'llms.txt' 网站,并支持按 'llms.txt' 或 'llms-full.txt' 文件类型进行过滤。

安装步骤

前提条件

  • Node.js 和 npm 或 pnpm (推荐使用 pnpm)

手动安装

  1. 克隆仓库

    git clone https://github.com/thedaviddias/mcp-llms-txt-explorer.git
    cd mcp-llms-txt-explorer
  2. 安装依赖

    pnpm install
  3. 构建服务器

    pnpm run build

服务器配置

此 MCP 服务器需要配置到 MCP 客户端中才能使用,例如 Claude Desktop。配置信息通常为 JSON 格式,您需要将以下配置添加到 MCP 客户端的配置文件中。

以 Claude Desktop 为例,配置文件路径通常为:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容 (JSON):

{
  "mcpServers": {
    "llms-txt-explorer": {
      "command": "/path/to/mcp-llms-txt-explorer/build/index.js"
      // 请将 "/path/to/mcp-llms-txt-explorer" 替换为您实际的项目路径
    }
  }
}

或者,您可以使用 'npx' 方式,无需指定项目路径:

{
  "mcpServers": {
    "llms-txt-explorer": {
      "command": "npx",
      "args": ["-y", "@thedaviddias/mcp-llms-txt-explorer"]
    }
  }
}

配置参数说明:

  • 'server name': 'llms-txt-explorer' (服务器名称,客户端用此名称识别和调用)
  • 'command': 服务器启动命令。
    • 路径方式: 指定服务器 'index.js' 文件的绝对路径。
    • npx 方式: 使用 'npx' 自动查找和执行 '@thedaviddias/mcp-llms-txt-explorer' 包。
  • 'args': 启动参数,'npx' 方式需要指定 '["-y", "@thedaviddias/mcp-llms-txt-explorer"]'。

基本使用方法

  1. 启动 MCP 客户端: 例如启动配置了 LLMS.txt Explorer Server 的 Claude Desktop。
  2. 连接服务器: MCP 客户端会自动连接到配置的 LLMS.txt Explorer Server。
  3. 使用资源和工具: 在 MCP 客户端中,您可以使用以下功能:
    • 浏览资源: 客户端应提供浏览资源的功能,您可以找到名为 "LLMS.txt Explorer" 的资源列表,其中包含了已知的 'llms.txt' 网站。
    • 调用工具: 客户端应提供调用工具的功能。您可以找到 "check_website" 和 "list_websites" 两个工具。
      • check_website: 输入网站 URL,即可检查该网站的 'llms.txt' 信息。
      • list_websites: 列出已知的 'llms.txt' 网站,并可以根据需要添加过滤条件。

具体操作方式请参考您使用的 MCP 客户端的文档。

信息

分类

网页与API