diff --git a/docs/specification.md b/docs/specification.md index 4accaad8b..1f597100d 100644 --- a/docs/specification.md +++ b/docs/specification.md @@ -24503,58 +24503,54 @@ Custom resource types are defined in YAML configuration files and registered via
# File: resource-types/database.yaml
-cleveragents:
- version: "3.0"
+name: local/database
+description: "A SQL database (PostgreSQL, MySQL, SQLite, etc.)"
+resource_kind: physical
+user_addable: true
-resource_type:
- name: local/database
- description: "A SQL database (PostgreSQL, MySQL, SQLite, etc.)"
- physical_or_virtual: physical
- user_addable: true
+# CLI arguments for `agents resource add local/database`
+cli_args:
+ - name: connection-string
+ type: string
+ required: true
+ description: "Database connection string (e.g., postgresql://host/dbname)"
+ validation_pattern: "^(postgresql|mysql|sqlite)://"
+ - name: schema
+ type: string
+ required: false
+ description: "Default schema to use"
+ - name: read-only
+ type: boolean
+ required: false
+ default: false
+ description: "Whether the database should be treated as read-only"
- # CLI arguments for `agents resource add local/database`
- cli_arguments:
- - name: connection-string
- type: string
- required: true
- description: "Database connection string (e.g., postgresql://host/dbname)"
- validation:
- pattern: "^(postgresql|mysql|sqlite)://"
- - name: schema
- type: string
- required: false
- description: "Default schema to use"
- - name: read-only
- type: boolean
- required: false
- default: false
- description: "Whether the database should be treated as read-only"
+# Sandbox and handler
+sandbox_strategy: transaction_rollback
+handler:
+ class: DatabaseHandler
+ module: cleveragents.resource.handlers.database
- # Sandbox and handler
- sandbox_strategy: transaction_rollback
- handler: DatabaseHandler
- checkpointable: true
+# Parent types (empty means can be top-level)
+parent_types: []
- # Allowed parent types (empty means can be top-level)
- allowed_parent_types: []
+# Child types
+child_types:
+ - type: local/db-schema
+ auto_discover: true
+ manual_link: false
+ description: "Discovered database schemas"
+ - type: local/db-table
+ auto_discover: true
+ manual_link: false
+ description: "Discovered tables within schemas"
- # Child types
- child_types:
- - type: local/db-schema
- auto_discover: true
- manual_link: false
- description: "Discovered database schemas"
- - type: local/db-table
- auto_discover: true
- manual_link: false
- description: "Discovered tables within schemas"
-
- # Capabilities
- capabilities:
- readable: true
- writable: true
- sandboxable: true
- checkpointable: true
+# Capabilities
+capabilities:
+ read: true
+ write: true
+ sandbox: true
+ checkpoint: true