Custom Tools

<?php

namespace modules\mymodule\tools;

use samuelreichor\coPilot\enums\AuditAction;
use samuelreichor\coPilot\helpers\PluginHelper;
use samuelreichor\coPilot\tools\ToolInterface;

class SearchFormieFormsTool implements ToolInterface
{
    public function getName(): string
    {
        return 'searchFormieForms';
    }

    public function getLabel(): string
    {
        return 'Search Formie Forms';
    }

    public function getAction(): AuditAction
    {
        return AuditAction::Search;
    }

    public function getDescription(): string
    {
        return 'Searches Formie forms by title. Returns form handles '
            . 'that can be used in Formie fields. Call this to find '
            . 'the correct form handle before setting a Formie field value.';
    }

    public function getParameters(): array
    {
        return [
            'type' => 'object',
            'properties' => [
                'query' => [
                    'type' => 'string',
                    'description' => 'Optional search query to filter forms by title.',
                ],
            ],
            'required' => [],
        ];
    }

    public function execute(array $arguments): array
    {
        if (!PluginHelper::isPluginInstalledAndEnabled('formie')) {
            return ['error' => 'Formie plugin is not installed.'];
        }

        $formsQuery = \verbb\formie\elements\Form::find();

        $query = $arguments['query'] ?? null;
        if ($query) {
            $formsQuery->title('*' . $query . '*');
        }

        $forms = $formsQuery->all();

        if (empty($forms)) {
            return ['results' => [], 'message' => 'No forms found.'];
        }

        $results = array_map(fn($form) => [
            'id' => $form->id,
            'title' => $form->title,
            'handle' => $form->handle,
        ], $forms);

        return [
            'results' => $results,
            'total' => count($results),
        ];
    }
}