使用说明
项目简介
Gyazo MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它将 Gyazo 图片服务集成到 LLM 应用中。通过该服务器,LLM 可以访问用户在 Gyazo 上存储的图片资源,并利用提供的工具进行图片检索和上传,从而增强 LLM 在图像处理和理解方面的能力。
主要功能点
- 资源 (Resources):
- 将用户的 Gyazo 图片以资源的形式托管在 MCP 服务器中。
- 每个图片资源包含图片的 URI ('gyazo-mcp://image_id')、MIME 类型(如 'image/png'),以及图片的名称(默认为图片ID或用户设置的标题)。
- 支持访问图片资源的元数据,包括标题、描述、来源应用、原始 URL 和 OCR 识别的文本信息(如果可用)。
- 工具 (Tools):
- 'gyazo_latest_image': 获取用户最新上传的 Gyazo 图片,包括图片内容和元数据。
- 'gyazo_image': 根据 Gyazo 图片 ID 获取指定图片的内容和元数据。
- 'gyazo_search': 通过关键词搜索用户在 Gyazo 上保存的图片。支持多种搜索条件,如关键词、标题、应用和时间范围。
- 'gyazo_upload': 上传图片到 Gyazo,支持上传 base64 编码的图像数据,并可设置标题、描述等元信息。
安装步骤
-
安装依赖: 确保已安装 Node.js 和 npm,然后克隆仓库到本地,在项目根目录下运行命令安装依赖:
npm ci -
构建服务器: 运行命令构建服务器代码:
npm run build构建成功后,会在 'build' 目录下生成 'index.js' 文件,这是服务器的入口文件。
-
获取 Gyazo API 访问令牌:
- 访问 https://gyazo.com/api 登录你的 Gyazo 账号。
- 在 API 页面找到并复制你的 访问令牌 (Access Token)。
-
配置环境变量:
- 设置名为 'GYAZO_ACCESS_TOKEN' 的环境变量,并将你的 Gyazo 访问令牌粘贴为该变量的值。
- 注意: 请根据你的操作系统和环境设置环境变量。例如,在 macOS 或 Linux 中,你可以在 '~/.bashrc' 或 '~/.zshrc' 文件中添加 'export GYAZO_ACCESS_TOKEN="your-access-token-here"',然后运行 'source ~/.bashrc' 或 'source ~/.zshrc' 使环境变量生效。在 Windows 中,你可以在“系统属性” -> “环境变量” 中进行设置。
服务器配置 (MCP 客户端配置)
要将 Gyazo MCP Server 集成到 MCP 客户端(例如 Claude Desktop),你需要配置客户端,告知其如何启动和连接到该服务器。以下是针对 Claude Desktop 的配置示例,你需要将以下 JSON 配置添加到 Claude Desktop 的配置文件中。
配置文件路径:
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
配置内容 (JSON):
{ "mcpServers": { "gyazo-mcp-server": { "command": "/path/to/gyazo-mcp-server/build/index.js", "env": { "GYAZO_ACCESS_TOKEN": "your-access-token-here" } } } }
配置参数说明:
- '"gyazo-mcp-server"': 服务器名称,可以自定义,用于在客户端中标识该服务器。
- '"command"': 服务器启动命令。
- '/path/to/gyazo-mcp-server/build/index.js' 需要替换为 你本地 gyazo-mcp-server 项目 'build/index.js' 文件的绝对路径。
- 确保该路径指向的是构建后的 'index.js' 文件。
- '"env"': 环境变量。
- '"GYAZO_ACCESS_TOKEN"': 指定传递给服务器的环境变量。
- '"your-access-token-here"': 请务必替换为你之前获取的 Gyazo API 访问令牌。
Docker 部署配置 (可选):
如果使用 Docker 部署,可以使用以下配置:
{ "mcpServers": { "gyazo-mcp-server": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "GYAZO_ACCESS_TOKEN", "gyazo-mcp-server" ], "env": { "GYAZO_ACCESS_TOKEN": "your-access-token-here" } } } }
Docker 配置参数说明:
- '"command"': '"docker"',指定使用 Docker 运行。
- '"args"': Docker 运行参数。
- '"run"': Docker 运行命令。
- '"-i"': 保持 STDIN 打开。
- '"--rm"': 容器退出后自动删除。
- '"-e"': 设置环境变量。
- '"GYAZO_ACCESS_TOKEN"': 环境变量名称。
- '"gyazo-mcp-server"': Docker 镜像名称,需要你先构建并标记 Docker 镜像为 'gyazo-mcp-server' (参考仓库 README 中的 Docker 构建步骤)。
- '"env"': 环境变量,与文件配置相同,用于传递 Gyazo API 访问令牌。
基本使用方法
配置完成后,当 MCP 客户端(如 Claude Desktop)启动时,它将尝试连接到 Gyazo MCP Server。连接成功后,LLM 就可以通过 MCP 协议与服务器交互,例如:
- 列出 Gyazo 图片资源: LLM 可以请求服务器列出可用的 Gyazo 图片资源,服务器将返回图片资源的列表,每个资源都有一个 'gyazo-mcp://' URI。
- 读取 Gyazo 图片内容和元数据: LLM 可以使用 'gyazo-mcp://' URI 请求读取特定图片资源的内容和元数据。服务器将返回图片的 base64 编码内容和文本格式的元数据。
- 调用工具: LLM 可以调用服务器提供的工具,例如 'gyazo_latest_image'、'gyazo_search' 和 'gyazo_upload',以获取最新图片、搜索图片或上传新图片。
具体的使用方式取决于 MCP 客户端的功能和界面,但核心思想是通过 MCP 协议,LLM 可以无缝地访问和利用 Gyazo 图片服务提供的能力。
信息
分类
AI与计算