DescribePolarClawAgentTools

Queries the PolarClaw Agent tool catalog.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application ID.	pa-xxx
AgentId	string	Yes	Agent ID	main
IncludePlugins	boolean	No	Specifies whether to include plugin tools.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	F45FFACC-xxx
Message	string	The response message.	success
Code	integer	The response status code.	200
ApplicationId	string	The application ID.	pa-xxx
AgentId	string	Agent ID	main
CurrentConfig	object	The current tool configuration.
Profile	string	The tool profile.	full
Allow	array	The list of explicitly allowed tools.
	string	The tool identifier.	read
AlsoAllow	array	The list of additionally allowed tools.
	string	The tool identifier.	send_message
Deny	array	The list of denied tools.
	string	The tool identifier.	exec
Profiles	array<object>	The list of available profiles.
	object	The profile information.
Id	string	The profile identifier.	full
Label	string	The display name.	全部工具
Groups	array<object>	The list of tool groups.
	array<object>	The tool group.
Id	string	The group identifier.	file
Label	string	The group name.	文件操作
Source	string	The source, which is core or a plugin ID.	core
Tools	array<object>	The list of tools.
	object	The tool information.
Id	string		read
Label	string		读取文件
Description	string		读取指定文件内容
Source	string		core
DefaultProfiles	array
	string		full

Examples

Success response

JSON format

{
  "RequestId": "F45FFACC-xxx",
  "Message": "success",
  "Code": 200,
  "ApplicationId": "pa-xxx",
  "AgentId": "main",
  "CurrentConfig": {
    "Profile": "full",
    "Allow": [
      "read"
    ],
    "AlsoAllow": [
      "send_message"
    ],
    "Deny": [
      "exec"
    ]
  },
  "Profiles": [
    {
      "Id": "full",
      "Label": "全部工具"
    }
  ],
  "Groups": [
    {
      "Id": "file",
      "Label": "文件操作",
      "Source": "core",
      "Tools": [
        {
          "Id": "read",
          "Label": "读取文件",
          "Description": "读取指定文件内容",
          "Source": "core",
          "DefaultProfiles": [
            "full"
          ]
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.