description property

  1. @override
String get description
override

Tool description for AI agents

Should clearly explain what the tool does and when to use it.

Implementation

@override
String get description => '''
Execute safe read-only SQL queries against the Serverpod database.

Security constraints:
- Only SELECT, SHOW, EXPLAIN, DESCRIBE, WITH queries allowed
- INSERT, UPDATE, DELETE, DROP, ALTER, CREATE, TRUNCATE blocked
- Maximum $maxRows rows per query (default $defaultMaxRows)
- ${queryTimeout.inSeconds} second timeout per query
- Connection pooling (max $maxConnections concurrent)
- All queries are validated before execution

Use cases:
- Inspect database state during development
- Verify data integrity
- Check table relationships
- Debug query issues
''';