sdk/com.m8test.script.core.api.ai.mcp.tools/ToolDescriptor

ToolDescriptor

interface ToolDescriptor

该接口表示工具的描述信息，包含了工具的名称、描述、必需参数和可选参数等信息。

通过此接口可以对工具的各项属性进行设置和获取，方便对工具进行管理和使用。

Author

M8Test, [email protected], https://m8test.com

Functions

Link copied to clipboard
abstract fun getDescription(): String

获取工具的描述信息。

Link copied to clipboard
abstract fun getName(): String

获取工具的名称。

Link copied to clipboard
abstract fun getOptionalParameters(): List<ToolParameterDescriptor>

获取工具的可选参数列表。

Link copied to clipboard
abstract fun getRequiredParameters(): List<ToolParameterDescriptor>

获取工具的必需参数列表。

Link copied to clipboard
abstract fun newToolParameterDescriptor(config: ToolParameterDescriptor.() -> Unit): ToolParameterDescriptor

创建一个新的工具参数描述符，并使用指定的配置块对其进行配置。

Link copied to clipboard
abstract fun setDescription(description: String)

设置工具的描述信息。

Link copied to clipboard
abstract fun setName(name: String)

设置工具的名称。

Link copied to clipboard
abstract fun setOptionalParameters(optionalParameters: List<ToolParameterDescriptor>)

设置工具的可选参数列表。

Link copied to clipboard
abstract fun setRequiredParameters(requiredParameters: List<ToolParameterDescriptor>)

设置工具的必需参数列表。