项目简介

QRCode_MCP 是一个基于 Model Context Protocol (MCP) 的服务器,专门用于生成二维码图片。它提供了一个名为 'qrcode' 的工具,允许用户通过简单的参数配置生成各种样式的二维码。

主要功能点

  • 二维码生成: 提供 'qrcode' 工具,根据文本内容生成二维码图片。
  • 自定义样式: 支持自定义二维码的尺寸、颜色、纠错级别和边距等样式参数。
  • MCP 协议: 遵循 Model Context Protocol 协议,方便集成到支持 MCP 协议的 LLM 应用中。

安装步骤

  1. 克隆仓库

    git clone https://github.com/1595901624/qrcode-mcp.git
    cd qrcode-mcp
  2. 安装依赖

    使用 pnpm 或 npm 安装项目依赖:

    pnpm install
    # 或
    npm install
  3. 构建项目

    使用 pnpm 或 npm 构建项目,生成可执行的 JavaScript 代码:

    pnpm run build
    # 或
    npm run build

服务器配置

为了让 MCP 客户端能够连接到 QRCode_MCP 服务器,需要在客户端的 MCP 设置文件中添加以下配置。请注意将 'path/to/qrcode-mcp/build/index.js' 替换为实际的 'index.js' 文件路径。

{
   "mcpServers": {
    "qrcode-mcp": {
      "command": "node",
      "args": ["path/to/qrcode-mcp/build/index.js"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

配置项说明:

  • 'server name': 服务器名称,这里是 'qrcode-mcp',客户端通过此名称识别服务器。
  • 'command': 启动服务器的命令,这里使用 'node' 运行 JavaScript 文件。
  • 'args': 传递给启动命令的参数,这里指定了构建后的 'index.js' 文件路径。
  • 'disabled': 是否禁用该服务器,默认为 'false' (启用)。
  • 'autoApprove': 自动批准的工具列表,默认为空数组。

基本使用方法

客户端可以通过 MCP 协议调用 'qrcode' 工具来生成二维码。

调用 'qrcode' 工具时,需要提供以下参数:

  • 'text' (必填): 要编码到二维码中的文本内容。
  • 'size' (可选): 二维码的尺寸,默认为 '256' 像素。
  • 'darkColor' (可选): 二维码深色模块的颜色,默认为 '#000000' (黑色)。
  • 'lightColor' (可选): 二维码浅色模块的颜色,默认为 '#ffffff' (白色)。
  • 'errorCorrectionLevel' (可选): 二维码的纠错级别,可选值为 'L', 'M', 'Q', 'H',默认为 'M'。
  • 'margin' (可选): 二维码的边距,默认为 '4'。

服务器将返回包含二维码图片的 JSON-RPC 响应,图片数据以 Base64 编码的 PNG 格式嵌入在响应中。客户端可以解析响应并展示或保存二维码图片。

信息

分类

AI与计算