<?php
/**
 * Tool interface.
 *
 * @package Aivexa
 */

declare(strict_types=1);

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Tool contract.
 */
interface Aivexa_Tool_Interface {

	/**
	 * Tool name used by OpenAI.
	 */
	public function get_name(): string;

	/**
	 * Human-readable description.
	 */
	public function get_description(): string;

	/**
	 * JSON schema parameters.
	 *
	 * @return array<string, mixed>
	 */
	public function get_parameters_schema(): array;

	/**
	 * Whether tool is enabled in settings.
	 */
	public function is_enabled(): bool;

	/**
	 * Execute tool.
	 *
	 * @param array<string, mixed> $arguments Tool arguments.
	 * @return array<string, mixed>|WP_Error
	 */
	public function execute( array $arguments );
}