1. 接口描述
接口请求域名: cngw.tencentcloudapi.com 。
从OpenAPI文件中解析出可导入的MCP tools
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCloudNativeAPIGatewayMCPToolsFromFile。 |
| Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Content | 是 | String | OpenAPI文件内容 示例值:{"openapi":"3.0.0","info":{"title":"Petstore","version":"1.0.0"},"paths":{"/pets":{"post":{"operationId":"createPet","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}}}}}} |
| Format | 是 | String | 文件内容格式 示例值:JSON |
| GatewayId | 是 | String | 网关实例ID 示例值:gateway-6fa655a5 |
| MCPServerId | 是 | String | MCP Server ID 示例值:a610d9b2-1b7d-4240-9af0-7761791b3ba1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | CNAPIGwParseMCPToolsResult | 解析结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据OpenAPI文件导入MCP Tools
输入示例
POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudNativeAPIGatewayMCPToolsFromFile
<公共请求参数>
{
"GatewayId": "gateway-6fa655a5",
"MCPServerId": "a610d9b2-1b7d-4240-9af0-7761791b3ba1",
"Content": "{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Petstore\",\"version\":\"1.0.0\"},\"servers\":[{\"url\":\"http://petstore.example.com/v1\"}],\"paths\":{\"/pets\":{\"get\":{\"operationId\":\"listPets\",\"summary\":\"List all pets\",\"parameters\":[{\"name\":\"limit\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\"}}]},\"post\":{\"operationId\":\"createPet\",\"summary\":\"Create a pet\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Pet name\"},\"tag\":{\"type\":\"string\",\"description\":\"Pet tag\"}}}}}}}},\"/pets/{petId}\":{\"get\":{\"operationId\":\"showPetById\",\"summary\":\"Info for a specific pet\",\"parameters\":[{\"name\":\"petId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}]}}}}",
"Format": "JSON"
}
输出示例
{
"Response": {
"Result": {
"DataList": [
{
"ContentType": "application/json",
"Description": "List all pets",
"InputParams": [
{
"Description": "",
"Name": "limit",
"Position": "query",
"Required": false,
"Type": "integer"
}
],
"Method": "GET",
"Name": "listPets",
"Path": "/pets",
"Status": "Valid",
"StatusMessage": "",
"UpstreamUrl": "http://petstore.example.com/v1/pets"
}
],
"TotalCount": 3
},
"RequestId": "9c38917a-a5e2-4507-b775-89e52053a426"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperation | FailedOperation.FailedOperation |
| FailedOperation.InternalError | FailedOperation.InternalError |
| FailedOperation.Role | FailedOperation.Role |
| InternalError | 内部错误。 |
| InternalError.QueryError | InternalError.QueryError |
| InternalError.UnknownError | InternalError.UnknownError |
| InvalidParameterValue.BadRequestFormat | InvalidParameterValue.BadRequestFormat |
| InvalidParameterValue.OperationFailed | InvalidParameterValue.OperationFailed |
| InvalidParameterValue.Region | InvalidParameterValue.Region |
| InvalidParameterValue.ResourceAlreadyExist | InvalidParameterValue.ResourceAlreadyExist |
| InvalidParameterValue.Specification | InvalidParameterValue.Specification |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.InstanceNotFound | ResourceNotFound.InstanceNotFound |
| ResourceNotFound.ResourceNotFound | ResourceNotFound.ResourceNotFound |
| UnauthorizedOperation.CamNoAuth | UnauthorizedOperation.CamNoAuth |
| UnauthorizedOperation.CamPassRoleNotExist | UnauthorizedOperation.CamPassRoleNotExist |
| UnauthorizedOperation.Uin | UnauthorizedOperation.Uin |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |