使用说明

项目简介

腾讯云 COS MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在帮助大语言模型 (LLM) 快速、便捷地接入腾讯云对象存储 (COS) 和数据万象 (CI) 的强大功能。它将腾讯云的云端存储和多媒体处理能力封装成标准化的 MCP 工具,使得 LLM 应用无需复杂的编码即可轻松调用云服务,实现文件管理、图片处理、音视频分析等功能。

主要功能点

  • 云端存储能力
    • 文件上传: 将本地或网络文件上传到腾讯云 COS 存储桶。
    • 文件下载: 从 COS 存储桶下载文件到本地。
    • 文件列表: 获取 COS 存储桶中的文件列表,方便浏览和管理云端文件。
  • 云端处理能力 (数据万象 CI)
    • 图片信息获取: 快速获取云端图片的元信息,如格式、尺寸等。
    • 图片超分辨率: 提升图片分辨率,增强图片细节。
    • 图片裁剪: 根据需求裁剪图片,提取关键区域。
    • 二维码识别: 识别图片中的二维码,获取包含的信息。
    • 图片质量评估: 评估图片质量,为图片优化提供参考。
    • 文字水印: 为图片添加文字水印,保护版权或添加标识。
    • 元数据/自然语言检索 (MateInsight): 通过元数据或自然语言描述检索图片,实现智能化的图片搜索。
    • 文档转 PDF: 将多种文档格式转换为 PDF,方便文档共享和阅读。
    • 视频封面: 为视频自动生成高质量封面,提升视频展示效果。

安装步骤

  1. 环境准备

    • 确保已安装 Node.js 和 npm (或 yarn)。
    • 拥有腾讯云账号,并开通 COS 和 数据万象 服务。
    • 获取 SecretIdSecretKey,以及 COS BucketRegion 信息 (参考参数说明)。
  2. 安装 COS MCP Server

    您可以通过以下方式安装 COS MCP Server:

    方式一:使用 npm 全局安装 (推荐)

    npm install -g cos-mcp@latest

    方式二:从源码安装

    git clone https://github.com/Tencent/cos-mcp.git
    cd cos-mcp
    npm install
    npm run build

服务器配置

COS MCP Server 可以通过 'stdio' (标准输入输出) 或 'sse' (Server-Sent Events) 两种方式与 MCP 客户端连接。以下是 MCP 客户端 'mcp.json' 的配置示例:

1. STDIO 模式 (本地模式,默认)

  • 配置示例

    {
      "mcpServers": {
        "cos-mcp": {
          "command": "npx",
          "args": [
            "cos-mcp",
            "--Region=yourRegion",  // 【必填】COS 存储桶所在地域,例如:ap-beijing
            "--Bucket=yourBucket",  // 【必填】COS 存储桶名称,例如:mybucket-123456
            "--SecretId=yourSecretId", // 【必填】腾讯云 SecretId
            "--SecretKey=yourSecretKey",// 【必填】腾讯云 SecretKey
            "--DatasetName=yourDatasetname" // 【可选】数据集名称,用于数据智能检索功能
          ]
        }
      }
    }

    或使用 JSON 格式配置 COS 参数:

    {
      "mcpServers": {
        "cos-mcp": {
          "command": "npx",
          "args": [
            "cos-mcp",
            "--cos-config='{\"Region\":\"yourRegion\",\"Bucket\":\"yourBucket\",\"SecretId\":\"yourSecretId\",\"SecretKey\":\"yourSecretKey\",\"DatasetName\":\"yourDatasetname\"}'" // 【必填】COS 配置 JSON 字符串,包含 Region, Bucket, SecretId, SecretKey, DatasetName
          ]
        }
      }
    }
  • 启动命令 (command): 'npx' (或全局安装后的 'cos-mcp',或源码安装后的 'node')

  • 启动参数 (args):

    • '--Region': COS 存储桶所在地域,例如 'ap-beijing'。
    • '--Bucket': COS 存储桶名称,例如 'mybucket-123456'。
    • '--SecretId': 腾讯云 SecretId。
    • '--SecretKey': 腾讯云 SecretKey。
    • '--DatasetName': (可选) 数据集名称,用于数据智能检索功能。
    • '--cos-config': (可选) COS 配置的 JSON 字符串,可以替代 '--Region', '--Bucket', '--SecretId', '--SecretKey', '--DatasetName' 等参数。

2. SSE 模式 (远程模式)

  • 启动 COS MCP Server (SSE 模式)

    使用 npm 全局安装:

    cos-mcp --Region=yourRegion --Bucket=yourBucket --SecretId=yourSecretId --SecretKey=yourSecretKey --DatasetName=yourDatasetname --port=3001 --connectType=sse

    或使用 JSON 格式配置 COS 参数:

    cos-mcp --cos-config='{"Region":"yourRegion","Bucket":"BucketName-APPID","SecretId":"yourSecretId","SecretKey":"yourSecretKey","DatasetName":"datasetName"}' --port=3001 --connectType=sse

    从源码启动 SSE 模式:

    cd cos-mcp
    npm run start:sse
  • MCP 客户端配置 (mcp.json)

    {
      "mcpServers": {
        "cos-mcp": {
          "url": "http://localhost:3001/sse" //  COS MCP Server 的 SSE 连接 URL,默认为 http://localhost:3001/sse
        }
      }
    }
  • 配置说明

    • url: COS MCP Server 的 SSE 连接 URL,默认为 'http://localhost:3001/sse',如果服务器端口修改,此处也需要相应修改。
    • 启动服务器时需要添加 '--port' 和 '--connectType=sse' 参数,以及 COS 相关的配置参数。

基本使用方法

  1. 启动 COS MCP Server: 根据选择的模式 (stdio 或 sse) 启动服务器。

  2. 配置 MCP 客户端: 在 MCP 客户端 (如 Cursor 编辑器) 的 'mcp.json' 文件中配置 COS MCP Server 连接信息。

  3. 在 LLM 中调用工具: 在 LLM 的交互界面中,可以使用工具名称和参数来调用 COS MCP Server 提供的功能。

    例如,使用 'putObject' 工具上传文件:

    {
      "tool_calls": [
        {
          "id": "upload_file_1",
          "type": "function",
          "function": {
            "name": "putObject",
            "arguments": {
              "filePath": "/path/to/your/local/file.txt", // 本地文件路径
              "fileName": "file_in_cos.txt",          // (可选) COS 中保存的文件名,默认为本地文件名
              "targetDir": "llm-uploads"              // (可选) COS 中保存的目标目录
            }
          }
        }
      ]
    }

    LLM 会解析工具调用请求,并发送给 COS MCP Server 执行。服务器执行成功后,会将结果返回给 LLM。

    您可以通过 'getCosConfig' 工具获取当前服务器的配置信息,方便调试和确认配置是否正确。

    其他工具的使用方法类似,请参考仓库 'src/server.ts' 文件中 'server.tool()' 的定义和参数说明。

信息

分类

数据库与文件