import type { ToolSchema } from "@scoopika/types";

{
	"name": "tool_name",
	"description": "The is the tool's description",
	"paramters": {
		"type": "object",
		"properties": {
			"prop1": {
				"type": "string",
				"description": "The property description"
			}
		},
		"required": ["prop1"]
	}
}

A ToolSchema object serves as a blueprint for external tools or custom functions that you can integrate with your agents in Scoopika. This schema defines the tool’s name, description, and most importantly, the expected parameters (inputs) it requires.

​
Props

name
string

This property specifies a clear and descriptive name for the tool.

description
string

Provide a concise description of the tool’s functionality and when the agent should call it.

parameters
ToolParamters | JSONSchema

This property defines the schema for the tool’s parameters. The schema is a critical element as it dictates the expected data format for the arguments that will be passed to the tool function. Scoopika will use this schema to validate the agent’s call.

Recommended to use an object JSONSchema and then use the createToolSchema with it. learn more

Reference to JSONSchema

import type { ToolSchema } from "@scoopika/types";

{
	"name": "tool_name",
	"description": "The is the tool's description",
	"paramters": {
		"type": "object",
		"properties": {
			"prop1": {
				"type": "string",
				"description": "The property description"
			}
		},
		"required": ["prop1"]
	}
}

Was this page helpful?

ToolCallStoreSession