使用说明

项目简介

ScreenshotOne MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它将 ScreenshotOne 的网页截图服务封装成 MCP 工具,使得支持 MCP 协议的 LLM 客户端可以通过标准化的方式调用 ScreenshotOne 的功能。

主要功能点

  • 网页截图工具: 提供 'render-website-screenshot' 工具,LLM 客户端可以调用此工具并提供网页 URL,服务器将返回该网页的截图(JPEG 格式)。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm。
  2. 下载代码: 从 GitHub 仓库 https://github.com/screenshotone/mcp 下载代码,或使用 'git clone' 命令克隆仓库到本地。
  3. 安装依赖并构建: 在项目根目录下打开终端,运行以下命令安装项目依赖并构建项目:
    npm run install && npm run build
  4. 获取 ScreenshotOne API Key: 访问 ScreenshotOne 注册账号并获取 API Key。

服务器配置

MCP 服务器需要在 MCP 客户端中进行配置才能连接使用。以下是针对 Claude for Desktop 或其他 MCP 客户端的配置示例 (JSON 格式):

{
    "mcpServers": {
        "screenshotone": {
            "command": "node",
            "args": ["path/to/screenshotone/mcp/build/index.js"],
            "env": {
                "SCREENSHOTONE_API_KEY": "<your api key>"
            }
        }
    }
}

配置参数说明:

  • 'server name': 'screenshotone' (服务器名称,用于在客户端中标识和引用,可以自定义)
  • 'command': 'node' (启动服务器的命令,这里使用 Node.js 运行 JavaScript 代码)
  • 'args': '["path/to/screenshotone/mcp/build/index.js"]' (启动命令的参数,指向服务器入口文件 'build/index.js' 的路径。 请将 'path/to/screenshotone/mcp' 替换为实际的项目代码路径)
  • 'env': '{"SCREENSHOTONE_API_KEY": "<your api key>"}' (环境变量配置,用于设置服务器运行所需的 API Key。 请将 '<your api key>' 替换为你从 ScreenshotOne 获取的 API Key)

注意: 'args' 中的路径需要根据你实际存放 'screenshotone/mcp' 项目的路径进行调整。

基本使用方法

  1. 启动 MCP 服务器: 在配置好 'SCREENSHOTONE_API_KEY' 环境变量后,可以通过以下命令启动服务器:

    SCREENSHOTONE_API_KEY=YOUR_API_KEY node build/index.js

    或者,如果你已经在客户端配置中设置了环境变量,可以直接运行:

    node build/index.js

    服务器成功启动后,会在控制台输出 'ScreenshotOneMCP Server running on stdio'。

  2. 在 MCP 客户端中使用:

    • 将上面提供的服务器配置添加到你的 MCP 客户端配置文件中(例如 Claude for Desktop 的 'claude_desktop_config.json')。
    • 确保客户端已连接到 'screenshotone' 服务器。
    • 在 LLM 客户端中,你可以指示 LLM 调用 'render-website-screenshot' 工具,并提供需要截图的网页 URL。例如,你可以对 LLM 说: “请使用 'render-website-screenshot' 工具截取 https://www.example.com 的网页截图”。
    • LLM 客户端会将请求发送到 ScreenshotOne MCP Server,服务器调用 ScreenshotOne API 获取截图,并将截图数据返回给客户端。客户端根据返回的数据进行展示或后续处理。

信息

分类

网页与API