README

Read-only database query tool for the Laravel AI SDK

Part of the shipfastlabs/toolkit catalog of reusable AI tools for the Laravel AI SDK.

Installation

composer require shipfastlabs/toolkit-database

Usage

Instantiate the tool and pass it to an agent's tools():

use Shipfastlabs\Toolkit\Database\DatabaseQueryTool;

$tools = [new DatabaseQueryTool];

Input schema

Matching rows are returned as pretty-printed JSON.

Configuration

This tool ships no config file or service provider. It reads its settings from the ai.toolkit.database key of the Laravel AI SDK's existing config/ai.php. Add the section manually:

// config/ai.php

return [

    // ... existing laravel/ai config ...

    'toolkit' => [
        'database' => [
            'connection' => env('TOOLKIT_DATABASE_CONNECTION'),
            'max_rows' => (int) env('TOOLKIT_DATABASE_MAX_ROWS', 100),
        ],
    ],

];

Safety

• Read-only enforced: only a single statement beginning with SELECT (or a WITH … SELECT CTE) is allowed.
• Write keywords rejected: INSERT, UPDATE, DELETE, DROP, ALTER and similar keywords are refused, even inside an otherwise-SELECT statement.
• Single statement only: queries containing ; separators are refused.
• Row cap: results are bounded by max_rows.
• Query failures are returned to the model as strings, not thrown.