mixtape-tools 0.4.0

Ready-to-use tool implementations for the mixtape agent framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
//! Describe table tool

use crate::prelude::*;
use crate::sqlite::error::SqliteToolError;
use crate::sqlite::manager::with_connection;
use crate::sqlite::types::{ColumnDefinition, TableInfo, Verbosity};

/// Input for describing a table
#[derive(Debug, Deserialize, JsonSchema)]
pub struct DescribeTableInput {
    /// Table name to describe
    pub table: String,

    /// Database file path. If not specified, uses the default database.
    #[serde(default)]
    pub db_path: Option<String>,

    /// Level of detail to include (default: summary)
    #[serde(default)]
    pub verbosity: Verbosity,
}

/// Tool for getting detailed schema information about a table
///
/// Returns column definitions including names, types, constraints,
/// and optionally row count and index information.
pub struct DescribeTableTool;

impl Tool for DescribeTableTool {
    type Input = DescribeTableInput;

    fn name(&self) -> &str {
        "sqlite_describe_table"
    }

    fn description(&self) -> &str {
        "Get detailed schema information for a table including column definitions, types, and constraints."
    }

    async fn execute(&self, input: Self::Input) -> Result<ToolResult, ToolError> {
        let table_name = input.table.clone();
        let verbosity = input.verbosity;

        let info = with_connection(input.db_path, move |conn| {
            // Check if table exists and get its type
            let table_type: String = conn
                .query_row(
                    "SELECT type FROM sqlite_master WHERE name = ? AND type IN ('table', 'view')",
                    [&table_name],
                    |row| row.get(0),
                )
                .map_err(|_| SqliteToolError::TableNotFound(table_name.clone()))?;

            // Get column info using PRAGMA
            let mut stmt = conn.prepare(&format!("PRAGMA table_info('{}')", table_name))?;

            let columns: Vec<ColumnDefinition> = stmt
                .query_map([], |row| {
                    let pk: i32 = row.get(5)?;
                    let notnull: i32 = row.get(3)?;
                    let default: Option<String> = row.get(4)?;

                    Ok(ColumnDefinition {
                        name: row.get(1)?,
                        data_type: row.get(2)?,
                        nullable: notnull == 0,
                        primary_key: pk > 0,
                        default,
                    })
                })?
                .filter_map(|r| r.ok())
                .collect();

            // Get row count if detailed
            let row_count = if verbosity == Verbosity::Detailed && table_type == "table" {
                conn.query_row(
                    &format!("SELECT COUNT(*) FROM \"{}\"", table_name),
                    [],
                    |row| row.get(0),
                )
                .ok()
            } else {
                None
            };

            Ok(TableInfo {
                name: table_name,
                table_type,
                columns,
                row_count,
            })
        })
        .await?;

        Ok(ToolResult::Json(serde_json::to_value(info)?))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::sqlite::test_utils::{unwrap_json, TestDatabase};

    #[tokio::test]
    async fn test_describe_table() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE users (
                id INTEGER PRIMARY KEY,
                name TEXT NOT NULL,
                email TEXT,
                age INTEGER DEFAULT 0
            );",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "users".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Detailed,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        assert_eq!(json["name"].as_str().unwrap(), "users");
        assert_eq!(json["columns"].as_array().unwrap().len(), 4);

        // Check id column
        let id_col = &json["columns"][0];
        assert_eq!(id_col["name"].as_str().unwrap(), "id");
        assert!(id_col["primary_key"].as_bool().unwrap());

        // Check name column (NOT NULL)
        let name_col = &json["columns"][1];
        assert_eq!(name_col["name"].as_str().unwrap(), "name");
        assert!(!name_col["nullable"].as_bool().unwrap());
    }

    #[test]
    fn test_tool_metadata() {
        let tool = DescribeTableTool;
        assert_eq!(tool.name(), "sqlite_describe_table");
        assert!(!tool.description().is_empty());
    }

    #[tokio::test]
    async fn test_describe_view() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT);
             CREATE VIEW active_users AS SELECT id, name FROM users WHERE id > 0;",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "active_users".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        assert_eq!(json["name"], "active_users");
        assert_eq!(json["type"], "view");
        assert_eq!(json["columns"].as_array().unwrap().len(), 2);
        assert_eq!(json["columns"][0]["name"], "id");
        assert_eq!(json["columns"][1]["name"], "name");
    }

    #[tokio::test]
    async fn test_describe_table_no_primary_key() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE logs (timestamp TEXT, message TEXT, level INTEGER);",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "logs".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        assert_eq!(json["columns"].as_array().unwrap().len(), 3);
        // No column should be a primary key
        for col in json["columns"].as_array().unwrap() {
            assert!(!col["primary_key"].as_bool().unwrap());
        }
    }

    #[tokio::test]
    async fn test_describe_table_composite_primary_key() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE order_items (
                order_id INTEGER,
                product_id INTEGER,
                quantity INTEGER,
                PRIMARY KEY (order_id, product_id)
            );",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "order_items".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        // Both order_id and product_id should be marked as primary keys
        let cols = json["columns"].as_array().unwrap();
        let order_id = cols.iter().find(|c| c["name"] == "order_id").unwrap();
        let product_id = cols.iter().find(|c| c["name"] == "product_id").unwrap();
        let quantity = cols.iter().find(|c| c["name"] == "quantity").unwrap();

        assert!(order_id["primary_key"].as_bool().unwrap());
        assert!(product_id["primary_key"].as_bool().unwrap());
        assert!(!quantity["primary_key"].as_bool().unwrap());
    }

    #[tokio::test]
    async fn test_describe_table_verbosity_summary() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT);
             INSERT INTO users VALUES (1, 'Alice');
             INSERT INTO users VALUES (2, 'Bob');
             INSERT INTO users VALUES (3, 'Charlie');",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "users".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        // Summary should NOT include row_count
        assert!(json.get("row_count").is_none() || json["row_count"].is_null());
    }

    #[tokio::test]
    async fn test_describe_table_verbosity_detailed() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT);
             INSERT INTO users VALUES (1, 'Alice');
             INSERT INTO users VALUES (2, 'Bob');
             INSERT INTO users VALUES (3, 'Charlie');",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "users".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Detailed,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        // Detailed should include row_count
        assert_eq!(json["row_count"], 3);
    }

    #[tokio::test]
    async fn test_describe_view_no_row_count_even_detailed() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT);
             INSERT INTO users VALUES (1, 'Alice');
             CREATE VIEW all_users AS SELECT * FROM users;",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "all_users".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Detailed,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        // Views should NOT have row_count even in Detailed mode
        assert!(json.get("row_count").is_none() || json["row_count"].is_null());
    }

    #[tokio::test]
    async fn test_describe_table_not_found() {
        let db = TestDatabase::new().await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "nonexistent".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await;

        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.to_string().contains("not found") || err.to_string().contains("nonexistent"));
    }

    #[tokio::test]
    async fn test_describe_table_with_default_values() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE config (
                key TEXT PRIMARY KEY,
                value TEXT DEFAULT 'empty',
                count INTEGER DEFAULT 0,
                active INTEGER DEFAULT 1
            );",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "config".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        let cols = json["columns"].as_array().unwrap();
        let value_col = cols.iter().find(|c| c["name"] == "value").unwrap();
        let count_col = cols.iter().find(|c| c["name"] == "count").unwrap();

        assert_eq!(value_col["default"], "'empty'");
        assert_eq!(count_col["default"], "0");
    }

    #[tokio::test]
    async fn test_describe_table_nullable_columns() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE users (
                id INTEGER PRIMARY KEY,
                name TEXT NOT NULL,
                email TEXT,
                phone TEXT NOT NULL
            );",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "users".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        let cols = json["columns"].as_array().unwrap();
        let name_col = cols.iter().find(|c| c["name"] == "name").unwrap();
        let email_col = cols.iter().find(|c| c["name"] == "email").unwrap();
        let phone_col = cols.iter().find(|c| c["name"] == "phone").unwrap();

        assert!(!name_col["nullable"].as_bool().unwrap());
        assert!(email_col["nullable"].as_bool().unwrap());
        assert!(!phone_col["nullable"].as_bool().unwrap());
    }

    #[tokio::test]
    async fn test_describe_table_data_types() {
        let db = TestDatabase::with_schema(
            "CREATE TABLE mixed_types (
                id INTEGER,
                name TEXT,
                price REAL,
                data BLOB,
                anything
            );",
        )
        .await;

        let result = DescribeTableTool
            .execute(DescribeTableInput {
                table: "mixed_types".to_string(),
                db_path: Some(db.key()),
                verbosity: Verbosity::Summary,
            })
            .await
            .unwrap();

        let json = unwrap_json(result);
        let cols = json["columns"].as_array().unwrap();
        assert_eq!(
            cols.iter().find(|c| c["name"] == "id").unwrap()["type"],
            "INTEGER"
        );
        assert_eq!(
            cols.iter().find(|c| c["name"] == "name").unwrap()["type"],
            "TEXT"
        );
        assert_eq!(
            cols.iter().find(|c| c["name"] == "price").unwrap()["type"],
            "REAL"
        );
        assert_eq!(
            cols.iter().find(|c| c["name"] == "data").unwrap()["type"],
            "BLOB"
        );
        // Column with no type should have empty string
        assert_eq!(
            cols.iter().find(|c| c["name"] == "anything").unwrap()["type"],
            ""
        );
    }
}