tencent cloud

APIs

DescribePlugin

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-11-04 21:49:20

1. API Description

Domain name for API request: adp.intl.tencentcloudapi.com.

This API is used to query plugin details.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribePlugin.
Version Yes String Common Params. The value used for this API: 2026-05-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
PluginId Yes String

Plugin id

SpaceId Yes String

Current space id

FieldMask No FieldMask

Get the specified field

Module No Integer

Plug-in display scenario. If not passed or set to 0, the scenario is not limited.

Enumeration values:

  • 0: Not limited
  • 1: Agent Mode
  • 2: Workflow
  • 3: Intelligent workbench

3. Output Parameters

Parameter Name Type Description
Plugin Plugin

Plugin details

RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Get plugin details

Input Example

POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePlugin
<Common request parameters>

{
    "PluginId": "c813b306-e49a-46ac-9bb9-c6897df4de4d",
    "SpaceId": "default_space"
}

Output Example

{
    "Response": {
        "Plugin": {
            "Config": {
                "MCPPluginConfig": {
                    "ExternalMCPServerUrl": "",
                    "MCPServerUrl": "",
                    "MCPTransport": 1,
                    "PluginHeader": [],
                    "PluginQuery": [],
                    "SSEReadTimeout": 300,
                    "Timeout": 60
                }
            },
            "CreateTime": "1745313719",
            "NeedOnline": false,
            "Operation": {
                "AllowExternalAccess": false,
                "BillingType": 1,
                "CategoryKey": "productivity_tools",
"Introduction": "Plugin description: This API supports web page search across the entire network.",
                "IsRecommended": false
            },
            "PluginId": "c813b306-e49a-46ac-9bb9-c6897df4de4d",
            "PluginVersion": 2,
            "Profile": {
"Author": "Intelligent Agent development platform"
"Description": "Search engine tool that supports web search across the entire network"
                "IconUrl": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/%E5%AE%98%E6%96%B9%E6%8F%92%E4%BB%B64%E6%9C%8817%E5%8F%B7%202/%E6%90%9C%E7%8B%97%E6%90%9C%E7%B4%A2.png",
"Name": "Sogou Search",
                "PluginClass": 1,
                "PluginKind": 2,
                "PluginSource": 1
            },
            "Statistics": {
                "CallCount": 355,
                "ToolCount": 1
            },
            "Status": 1,
            "ToolList": [
                {
                    "Billing": {
                        "BillingType": 1
                    },
                    "CallCount": 355,
"Description": "Sogou search tool that supports web page search across the entire network."
                    "Name": "SougouWebSearch",
                    "PluginId": "c813b306-e49a-46ac-9bb9-c6897df4de4d",
                    "ToolAccessMode": 0,
                    "ToolConfig": {
                        "MCPToolConfig": {
                            "Inputs": [
                                {
                                    "AnyOf": [],
                                    "DefaultValue": "",
"Description": "Search by specified website address. Only single domain filtering is supported, for example: zhihu.com"
                                    "IsGlobalHidden": false,
                                    "IsRequired": false,
                                    "Name": "Insite",
                                    "OneOf": [],
                                    "SubParams": [],
                                    "Type": 0
                                }
                            ],
                            "Outputs": [
                                {
                                    "Description": "",
                                    "Name": "result",
                                    "RenderMode": 0,
                                    "SubParams": [
                                        {
                                            "Description": "",
                                            "Name": "content",
                                            "RenderMode": 0,
                                            "SubParams": [
                                                {
                                                    "Description": "",
                                                    "Name": "type",
                                                    "RenderMode": 0,
                                                    "SubParams": [],
                                                    "Type": 0
                                                }
                                            ],
                                            "Type": 9
                                        }
                                    ],
                                    "Type": 4
                                }
                            ]
                        }
                    },
                    "ToolId": "1146f40c-d466-43f1-94a8-721b2b71e711"
                }
            ],
            "UpdateTime": "1780533001",
            "UserState": {
                "IsFavorite": false,
                "IsInWhiteList": false,
                "WhiteListType": 0
            }
        },
        "RequestId": "6b47ad2d-8c26-4859-8518-4e2837096e8e"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan