Skip to content

dinghuazhou/sample-mcp-server-tos

Repository files navigation

TOS MCP Server

TOS 官方推出的 MCP Server 提供强大的查询能力,支持通过自然语言便捷地探索和检索 TOS 中存储的内容,提升了数据访问的直观性与效率。可以与火山引擎云产品 MCP 组合,助力构建更智能的业务应用场景。

版本 v0.2.0
描述 基于 MCP 管理 TOS 资源,智能化探索数据
分类 存储
标签 搜索,视频,图片,文本

Tools

本 MCP Server 产品提供以下 Tools (工具/能力):

Tool 1: list_buckets

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎TOS的存储桶列表。

调试所需的输入参数:

输入:

{
  "inputSchema": {
    "type": "object",
    "required": [],
    "properties": {}
  },
  "name": "list_buckets",
  "description": "查询您账号下拥有的所有存储桶的列表。"
}

输出:

  • 返回您账号下拥有的存储桶列表,包含桶名、创建时间、桶位置信息、访问域名等信息。

最容易被唤起的 Prompt示例

列举火山引擎 TOS 的存储桶列表。

Tool 2: list_objects

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎TOS桶下的对象列表,每次请求都会返回存储桶中的部分或全部对象(最多 1000 个)。您可以使用请求参数作为选择条件,返回存储桶中对象的子集。

调试所需的输入参数:

输入:

{
  "inputSchema": {
    "type": "object",
    "required": [
      "bucket"
    ],
    "properties": {
      "bucket": {
        "type": "string",
        "description": "用户指定的存储桶名称"
      },
      "prefix": {
        "type": "string",
        "description": "可选的对象前缀"
      },
      "start_after": {
        "type": "string",
        "description": "列举对象的起始位置。您可以通过指定对象的起始位置分页列举对象"
      },
      "continuation_token": {
        "type": "string",
        "description": "指定列举操作从该 Token 开始,通常从上次请求返回的 NextContinuationToken 中获取此 Token"
      }
    }
  },
  "name": "list_objects",
  "description": "查询您指定存储桶的对象列表"
}

输出:

  • 返回您指定存储下的对象列表,包含对象名、对象的最后修改时间、ETag、对象大小、存储类型等信息。

最容易被唤起的 Prompt示例

列举火山引擎 TOS 的 example 桶下的对象。

Tool 3: get_object tool

类型

SaaS

详细描述

从 TOS 检索对象,需要指定桶名和对象的完整路径。对于文本内容的对象,比如文本文件、CSV 文件等,该工具返回的是其内容。对于图片、视频等二进制对象,该工具返回的是Base64编码的内容。

调试所需的输入参数:

输入:

{
  "inputSchema": {
    "type": "object",
    "required": [
      "bucket",
      "key"
    ],
    "properties": {
      "bucket": {
        "type": "string",
        "description": "用户指定的存储桶名称"
      },
      "key": {
        "type": "string",
        "description": "用户需要读取的对象名,需要指定完整的对象名"
      }
    }
  },
  "name": "get_object",
  "description": "获取指定对象的内容,对于文本内容的对象,比如文本文件、CSV 文件等,该工具返回的是其内容。对于图片、视频等二进制对象,该工具返回的是Base64编码的内容。"
}

输出:

  • 返回具体的对象内容,对于文本内容的对象,比如文本文件、CSV 文件等,该工具返回的是内容。对于图片、视频等二进制对象,该工具返回的是Base64编码的内容。

最容易被唤起的 Prompt示例

读取火山引擎 TOS 桶example下对象名为example.txt的文件内容

可适配平台

方舟,python,cursor

服务开通链接 (整体产品)

https://console.volcengine.com/tos

鉴权方式

火山引擎,从 volcengine 管理控制台获取 volcengine 访问密钥 ID、秘密访问密钥和区域,请在.env文件中设置相关环境变量

环境变量

以下环境变量可用于配置MCP服务器:

环境变量 描述 默认值
VOLCENGINE_ACCESS_KEY 火山引擎账号 ACCESS KEY -
VOLCENGINE_SECRET_KEY 火山引擎账号 SECRET KEY -
VOLCENGINE_REGION 火山引擎 TOS region -
TOS_ENDPOINT 火山引擎 TOS Endpoint -
SECURITY_TOKEN 火山引擎 Security Token,可选 -
TOS_BUCKETS 指定访问的 TOS 桶,可选 -

安装部署

系统依赖

  • 安装 Python 3.10 或者更高版本
  • 安装 uv
    • 如果是linux系统
    curl -LsSf https://astral.sh/uv/install.sh | sh
    
    • 如果是window系统
    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
    
  • 同步依赖项并更uv.lock:
    uv sync
  • 构建mcp server:
    uv build

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-tos.

本地配置

添加以下配置到你的 mcp settings 文件中

{
  "mcpServers": {
    "tos-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/PARENT/FOLDER/src/mcp_server_tos",
        "run",
        "mcp-server-tos"
      ]
    }
  }
}

在不同平台的配置

方舟

体验中心

[示例如下]

  1. 查看MCP Server 详情 在大模型生态广场,选择合适的MCP Server,并查看详情
  2. 选择MCP Server即将运行的平台 检查当前MCP Server 已适配的平台,并选择合适的平台
  3. 查看并对比可用的Tools 仔细查看可用的Tools的功能描述与所需的输入参数,并尝试运行对应的功能。
  4. 获取专属的URL或代码示例 检查账号登录状态与服务开通情况,生成唯一URL
  5. 去对应的Client的平台进行使用 点击快捷跳转按钮,前往方舟平台的体验中心进行对应MCP Server的体验

产品截图/视频 - optional

Cursor

部署

[示例如下]

UVX

{
  "mcpServers": {
    "tos-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/volcengine/mcp-server#subdirectory=server/mcp_server_tos",
        "mcp-server-tos"
      ],
      "env": {
        "VOLCENGINE_ACCESS_KEY": "your access-key-id",
        "VOLCENGINE_SECRET_KEY": "your access-key-secret",
        "VOLCENGINE_REGION": "tos region",
        "TOS_ENDPOINT": "tos endpoint",
        "SECURITY_TOKEN": "your security token",
        "TOS_BUCKET": "your specific bucket"
      }
    }
  }
}

License

volcengine/mcp-server is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages