使用说明

项目简介

gyazo-mcp-server 是一个基于 Model Context Protocol (MCP) 的服务器,它将你的 Gyazo 图片库集成到支持 MCP 协议的 LLM 应用中。通过这个服务器,LLM 应用可以访问和利用你 Gyazo 账户中的图片资源,包括图片内容、元数据以及 OCR 识别的文本信息。

主要功能点

  • 资源访问 (Resources)
    • 将你的 Gyazo 图片以资源的形式提供给 LLM 应用。
    • 每个 Gyazo 图片都拥有一个 'gyazo-mcp://' 开头的唯一资源标识符 (URI)。
    • LLM 应用可以通过 URI 获取图片的原始图像内容、以及包括标题、描述、应用来源、原始链接等在内的元数据。
    • 支持访问多种图片格式,如 JPEG、PNG 等。
  • 工具调用 (Tools)
    • 'gyazo_latest_image': 允许 LLM 应用获取你 Gyazo 账户中最新上传的图片及其元数据,包括 OCR 文本(如果 Gyazo 提供了 OCR)。
    • 'gyazo_search': 允许 LLM 应用通过关键词搜索你的 Gyazo 图片库,并返回匹配的图片列表及其基本信息。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的电脑上已安装 Node.js 和 npm (Node 包管理器)。
  2. 克隆仓库: 将 gyazo-mcp-server 仓库克隆到本地:
    git clone https://github.com/yuiseki/gyazo-mcp-server.git
  3. 进入仓库目录: 使用命令行工具进入克隆下来的 'gyazo-mcp-server' 目录:
    cd gyazo-mcp-server
  4. 安装依赖: 运行 npm 命令安装项目依赖:
    npm install
  5. 构建服务器: 运行 npm 命令构建服务器代码:
    npm run build
  6. 获取 Gyazo API 访问令牌:
    • 访问 https://gyazo.com/api 并登录你的 Gyazo 账户。
    • 按照页面指引创建应用并获取 API 访问令牌 (Access Token)。
  7. 设置环境变量: 设置 'GYAZO_ACCESS_TOKEN' 环境变量,并将你的 Gyazo API 访问令牌设置为该环境变量的值。 注意:请勿将访问令牌直接写入配置文件,以确保安全性。 具体设置环境变量的方法取决于你的操作系统。

服务器配置

要将 'gyazo-mcp-server' 集成到支持 MCP 协议的 LLM 客户端(例如 Claude Desktop),你需要配置客户端以连接到此服务器。以下是针对 Claude Desktop 的配置示例,你需要将配置信息添加到 Claude Desktop 的配置文件中。

Claude Desktop 配置文件路径:

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

配置信息 (JSON 格式):

将以下 JSON 代码添加到 'claude_desktop_config.json' 文件的 'mcpServers' 字段中。如果 'mcpServers' 字段不存在,请创建它。

{
  "mcpServers": {
    "gyazo-mcp-server": {
      "command": "/path/to/gyazo-mcp-server/build/index.js",
      "env": {
        "GYAZO_ACCESS_TOKEN": "your-access-token-here" // 请将 "your-access-token-here" 替换为你的 Gyazo API 访问令牌
      }
    }
  }
}

配置参数说明:

  • 'server name': 'gyazo-mcp-server' - 服务器名称,用于在客户端中标识和引用。
  • 'command': '/path/to/gyazo-mcp-server/build/index.js' - 请务必将 '/path/to/gyazo-mcp-server/build/index.js' 替换为 'gyazo-mcp-server' 仓库中 'build/index.js' 文件的实际绝对路径。 这是服务器的启动命令,指向构建后的服务器入口文件。
  • 'env': 环境变量配置。
    • 'GYAZO_ACCESS_TOKEN': 请务必将 'your-access-token-here' 替换为你从 Gyazo API 获取的访问令牌。 服务器启动时会读取此环境变量以进行 API 鉴权。

基本使用方法

  1. 启动服务器: 配置完成后,当 LLM 客户端(如 Claude Desktop)启动时,'gyazo-mcp-server' 会作为 MCP 服务器自动启动。 由于服务器通过 stdio 传输协议与客户端通信,你通常不需要手动运行服务器程序。
  2. 在 LLM 应用中使用: 在支持 MCP 协议的 LLM 应用中,你可以使用以下方式来访问 Gyazo 图片资源和工具:
    • 引用资源: 使用 'gyazo-mcp:///image_id' 格式的 URI 引用特定的 Gyazo 图片资源。例如,'@gyazo-mcp:///your_image_id'。
    • 调用工具:
      • 使用 '@gyazo_latest_image' 工具获取最新的 Gyazo 图片。
      • 使用 '@gyazo_search' 工具,并提供搜索关键词来搜索 Gyazo 图片。例如,'@gyazo_search query="关键词"'。

具体的使用方式和语法可能会因不同的 LLM 客户端而略有差异,请参考你使用的 LLM 客户端的文档。

信息

分类

AI与计算