使用说明

项目简介

Image Reader MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,专注于图像处理功能。它允许 MCP 客户端访问服务器管理的图像资源,并调用工具进行图像分析、格式转换、尺寸调整以及目录扫描等操作。

主要功能点

  • 图像资源管理:
    • 将指定目录下的图片文件作为资源托管,可通过 'image://' URI 访问。
    • 提供图片资源的元数据信息,例如文件名、格式、尺寸、大小、创建/修改时间等。
    • 支持生成图片缩略图。
  • 图像处理工具:
    • 'analyze_image': 分析图像,返回详细的元数据信息和缩略图。
    • 'resize_image': 调整图像尺寸,并保存到新文件。支持指定宽度、高度和缩放模式。
    • 'convert_format': 转换图像格式,并保存到新文件。支持多种常见图像格式,可设置质量参数。
    • 'scan_directory': 扫描指定目录(可递归),返回目录下所有图像文件的元数据。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm 包管理器。
  2. 克隆仓库: 将 'mcp-image-reader' 仓库克隆到本地。
  3. 安装依赖: 在仓库根目录下运行 'npm install' 命令安装项目依赖。
  4. 构建服务器: 运行 'npm run build' 命令编译 TypeScript 代码。

服务器配置

要将 Image Reader MCP Server 集成到 MCP 客户端(例如 Claude Desktop),你需要配置客户端的 MCP 服务器列表。在客户端的配置文件(例如 'claude_desktop_config.json')中添加以下配置信息:

{
  "mcpServers": {
    "image-reader": {
      "command": "/path/to/mcp-image-reader/build/index.js"
    }
  }
}
  • 'server name': '"image-reader"' (服务器名称,可以自定义,用于在客户端中标识该服务器)
  • 'command': '"/path/to/mcp-image-reader/build/index.js"' (服务器启动命令,指向编译后的 'index.js' 文件。注意: 请将 '/path/to/mcp-image-reader' 替换为你实际的仓库路径)

基本使用方法

  1. 启动服务器: 在仓库根目录下,可以通过 'node build/index.js' 命令启动服务器。或者,如果已经配置了客户端,客户端启动时会自动启动配置的 MCP 服务器。
  2. 客户端交互: MCP 客户端会通过 JSON-RPC 协议与服务器进行通信。客户端可以发送请求来:
    • 列出图像资源 ('ListResourcesRequest')
    • 读取图像资源的内容和元数据 ('ReadResourceRequest')
    • 调用图像处理工具 ('CallToolRequest'),例如分析图像、调整尺寸、转换格式或扫描目录。
  3. 环境变量: 可以通过设置 'IMAGE_DIR' 环境变量来指定服务器扫描的默认图像目录。如果未设置,则默认扫描服务器运行的当前目录。

调试: 可以使用仓库 README.md 中推荐的 MCP Inspector 工具进行调试。

信息

分类

数据库与文件