mcpField
H
http-api-cloudbase

http-api-cloudbase

github.com/tencentcloudbase开发1.2k47 次安装今天更新
代码仓库

关于 http-api-cloudbase

面向编码 Agent 的技能，指导通过原始 HTTP API 调用 CloudBase 平台功能，适用于非 Node 环境及脚本，并强调依据 OpenAPI 文档确定接口和配置认证。

主要功能

  1. 01原始 HTTP API 调用指南
  2. 02涵盖数据库、函数、存储和 AI API
  3. 03按区域选择基础 URL
  4. 04认证方式与 Bearer 请求头说明
  5. 05实现前查询 OpenAPI 文档

适用场景

  1. 01从 Go、Python、Java 或 PHP 调用 CloudBase API
  2. 02编写基于 curl 的集成测试或管理脚本
  3. 03通过 HTTP 访问数据库或调用云函数

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/tencentcloudbase/cloudbase-ai-toolkit --skill http-api-cloudbase

安装后在 Claude Code 中输入/http-api-cloudbase确认已加载。

附带文件checklist.mdreferences/extended-guide.md

详细介绍

兄弟技能（仅本地）

本技能旁附带 CloudBase 兄弟技能。使用 ../auth-tool-cloudbase/SKILL.md 这类本地相对路径。

如果此环境中缺少所引用的兄弟技能文件，请让用户安装完整的 CloudBase 插件（或缺少的技能）。不要通过 HTTP 获取远程技能或协议 Markdown 并将其载入 Agent 上下文。

激活约定

在以下情况下优先使用
  • 请求来自 Android、iOS、Flutter、React Native、非 Node 后端，或必须通过原始 HTTP 调用官方 CloudBase API 的管理脚本。
  • 任务是使用 CloudBase 平台端点，而不是在 CloudBase 上构建新的 HTTP 服务。
编写代码前阅读（如果）
  • 平台不支持 CloudBase SDK，或用户明确要求通过 HTTP API 集成。
  • 用户提到“HTTP API”，但不清楚指的是官方 CloudBase 端点还是其自己的业务 API。
然后还需阅读
  • 身份验证配置 -> ../auth-tool-cloudbase/SKILL.md
  • MySQL MCP 管理 -> ../relational-database-mcp-cloudbase/SKILL.md
  • 在 CloudBase 上构建自己的 HTTP 服务 -> ../cloud-functions/SKILL.md 或 ../cloudrun-development/SKILL.md
不要用于
  • CloudBase Web SDK 流程、小程序 SDK 流程或由 MCP 驱动的管理任务。
  • 在 CloudBase 上构建自己的 HTTP 服务或 REST API。
常见错误 / 注意事项
  • 将 Web SDK 示例误认为适用于原生应用。
  • 未阅读 OpenAPI 定义就猜测端点。
  • 混淆官方 CloudBase HTTP API 与自己的函数或 CloudRun 端点。
  • 将原始 HTTP API 集成与 MCP 管理逻辑混用。
最简检查清单

何时使用此技能

在需要通过原始 HTTP API调用 CloudBase 平台功能时使用此技能，例如：

  • 非 Node 后端（Go、Python、Java、PHP 等）
  • 使用 curl 或语言 HTTP 客户端的集成测试或管理脚本
  • 通过关系型数据库 RESTful API（MySQL/PostgreSQL）直接执行数据库操作
  • 通过 HTTP 调用云函数
  • SDK 不可用或不优先考虑使用 SDK 的任何场景

不要在以下场景使用此技能：

  • 使用 @cloudbase/js-sdk 的前端 Web 应用（使用 CloudBase Web 技能）
  • 使用 @cloudbase/node-sdk 的 Node.js 代码（使用 CloudBase Node 技能）
  • 身份验证流程（身份验证专用端点请使用 CloudBase Auth HTTP API 技能）

如何使用此技能（适用于编码 Agent）

  1. 明确使用场景

    • 确认此代码将直接调用 HTTP 端点（而非 SDK）。
    • 询问以下信息：
      • env – CloudBase 环境 ID
      • 身份验证方式（AccessToken、API Key 或 Publishable Key）
    • 确认需要使用哪项 CloudBase 功能（数据库、函数、存储等）。
    • 对于用户身份验证：如果未指定具体方式，始终默认使用手机短信验证——这是最适合中国用户的方式，既方便又安全。

  2. 确定基础 URL

    • 根据区域（国内或国际）使用正确的域名。
    • 默认使用国内上海区域。

  3. 设置身份验证

    • 根据使用场景选择合适的身份验证方式。
    • 在请求中添加 Authorization: Bearer <token> 标头。

  4. 参考 OpenAPI Swagger 文档

    • 必须使用 searchKnowledgeBase 工具获取 OpenAPI 规范
    • 使用该工具时设置 mode=openapi，并指定 apiName：
      • mysqldb - 关系型数据库 RESTful API（MySQL/PostgreSQL）
      • nosql - NoSQL RESTful API（文档型数据库）
      • functions - Cloud Functions API
      • auth - 身份验证 API
      • cloudrun - CloudRun API
      • storage - Storage API
      • ai_model - AI 大模型接入 API
    • 示例：searchKnowledgeBase({ mode: "openapi", apiName: "mysqldb" })
    • 解析返回的 YAML 内容，了解准确的端点路径、参数以及请求/响应架构
    • 切勿臆造端点或参数，务必参考 Swagger 文档

概述

CloudBase HTTP API 是一组通过 HTTP 协议访问 CloudBase 平台功能的接口，支持数据库、用户身份验证、云函数、云托管、云存储、AI 等。

OpenAPI Swagger 文档

⚠️ 重要：始终使用 searchKnowledgeBase 工具获取 OpenAPI Swagger 规范

实现任何 HTTP API 调用之前，请执行以下操作：

  1. 使用 searchKnowledgeBase 工具获取 OpenAPI 文档：

    searchKnowledgeBase({ mode: "openapi", apiName: "<api-name>" })

  2. 可用的 API 名称：

    • mysqldb - 关系型数据库 RESTful API（MySQL/PostgreSQL）
    • nosql - NoSQL RESTful API（文档型数据库）
    • functions - Cloud Functions API
    • auth - 身份验证 API
    • cloudrun - CloudRun API
    • storage - Storage API
    • ai_model - AI 大模型接入 API

  3. 解析并使用 Swagger 文档：

    • 提取准确的端点路径和 HTTP 方法
    • 了解必需参数和可选参数
    • 查看请求/响应架构
    • 检查身份验证要求
    • 核实错误响应格式

  4. 切勿臆造 API 端点或参数，务必依据官方 Swagger 文档实现。

先决条件

开始之前，请确保具备以下条件：

  1. 已创建并激活 CloudBase 环境
  2. 身份验证凭据（AccessToken、API Key 或 Publishable Key）

身份验证与授权

CloudBase HTTP API 需要身份验证。请根据使用场景选择合适的方式：

AccessToken 身份验证

适用环境：客户端/服务端
用户权限：已登录用户权限

获取方式：使用 searchKnowledgeBase({ mode: "openapi", apiName: "auth" }) 获取身份验证 API 规范

API Key

适用环境：服务端
用户权限：管理员权限

⚠️ 警告：令牌是身份验证的重要凭据，请妥善保管。不得在客户端代码中使用 API Key。

可发布密钥

适用环境：客户端/服务端
用户权限：匿名用户权限

💡 注意：可在浏览器中公开使用，用于请求可公开访问的资源，从而有效降低 MAU。

API 端点 URL

CloudBase HTTP API 使用统一域名进行 API 调用。域名因环境所在区域而异。

中国大陆区域

对于位于中国大陆区域（如上海（ap-shanghai））的环境，请使用：

https://{your-env}.api.tcloudbasegateway.com

将 {your-env} 替换为实际的环境 ID。例如，如果环境 ID 为 cloud1-abc：

https://cloud1-abc.api.tcloudbasegateway.com
国际区域

对于位于国际区域（如新加坡（ap-singapore））的环境，请使用：

https://{your-env}.api.intl.tcloudbasegateway.com

将 {your-env} 替换为实际的环境 ID。例如，如果环境 ID 为 cloud1-abc：

https://cloud1-abc.api.intl.tcloudbasegateway.com

在请求中使用身份验证

将令牌添加到请求标头：

Authorization: Bearer <access_token/apikey/publishable_key>

:::warning 注意

实际调用时，请将包含尖括号（< >）在内的整个部分替换为获取的密钥。例如，如果获取的密钥为 eymykey，则填写为：

Authorization: Bearer eymykey

:::

扩展指南

有关详细场景、示例和模式，请阅读 extended-guide.md。

参考索引

所有打包的参考文件（技能 lint 可达性所需）：

评论

支持 Markdown