postgres-mcp 0.3.2

A PostgreSQL MCP (Model Context Protocol) server implementation for building AI agents
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
use arc_swap::ArcSwap;
use serde::{Deserialize, Serialize};
use sqlparser::ast::Statement;
use sqlx::postgres::PgPool;
use std::collections::HashMap;
use std::sync::Arc;
use thiserror::Error;

#[allow(unused)]
#[derive(Error, Debug)]
pub enum PgMcpError {
    #[error("Connection not found for ID: {0}")]
    ConnectionNotFound(String),

    #[error("SQL validation failed for query '{query}': {kind}")]
    ValidationFailed {
        kind: ValidationErrorKind,
        query: String,
        details: String,
    },

    #[error("Database operation '{operation}' failed: {underlying}")]
    DatabaseError {
        operation: String,
        underlying: String,
    },

    #[error("Serialization failed: {0}")]
    SerializationError(#[from] serde_json::Error),

    #[error("Database connection failed: {0}")]
    ConnectionError(String),

    #[error("Internal error: {0}")]
    InternalError(String),
}

#[derive(Error, Debug)]
pub enum ValidationErrorKind {
    #[error("Invalid statement type, expected {expected}")]
    InvalidStatementType { expected: String },
    #[error("Failed to parse SQL")]
    ParseError,
}

impl From<sqlx::Error> for PgMcpError {
    fn from(e: sqlx::Error) -> Self {
        let msg = e.to_string();
        if let Some(db_err) = e.as_database_error() {
            PgMcpError::DatabaseError {
                operation: "unknown".to_string(),
                underlying: db_err.to_string(),
            }
        } else if msg.contains("error connecting") || msg.contains("timed out") {
            PgMcpError::ConnectionError(msg)
        } else {
            PgMcpError::DatabaseError {
                operation: "unknown".to_string(),
                underlying: msg,
            }
        }
    }
}

#[allow(dead_code)]
#[derive(Debug, Clone)]
pub(crate) struct Conn {
    pub(crate) id: String,
    pub(crate) conn_str: String,
    pub(crate) pool: PgPool,
}

#[derive(Debug, Clone)]
pub struct Conns {
    pub(crate) inner: Arc<ArcSwap<HashMap<String, Conn>>>,
}

#[derive(Debug, Clone)]
pub struct PgMcp {
    pub(crate) conns: Conns,
}

#[derive(Debug, sqlx::FromRow, Serialize, Deserialize)]
struct JsonRow {
    ret: sqlx::types::Json<serde_json::Value>,
}

impl Conns {
    pub(crate) fn new() -> Self {
        Self {
            inner: Arc::new(ArcSwap::new(Arc::new(HashMap::new()))),
        }
    }

    pub(crate) async fn register(&self, conn_str: String) -> Result<String, PgMcpError> {
        let pool = PgPool::connect(&conn_str)
            .await
            .map_err(|e| PgMcpError::ConnectionError(e.to_string()))?;
        let id = uuid::Uuid::new_v4().to_string();
        let conn = Conn {
            id: id.clone(),
            conn_str: conn_str.clone(),
            pool,
        };

        let mut conns = self.inner.load().as_ref().clone();
        conns.insert(id.clone(), conn);
        self.inner.store(Arc::new(conns));

        Ok(id)
    }

    pub(crate) fn unregister(&self, id: String) -> Result<(), PgMcpError> {
        let mut conns = self.inner.load().as_ref().clone();
        if conns.remove(&id).is_none() {
            return Err(PgMcpError::ConnectionNotFound(id));
        }
        self.inner.store(Arc::new(conns));
        Ok(())
    }

    pub(crate) async fn query(&self, id: &str, query: &str) -> Result<String, PgMcpError> {
        let operation = "query (SELECT)";
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let validated_query =
            validate_sql(query, |stmt| matches!(stmt, Statement::Query(_)), "SELECT")?;

        let prepared_query = format!(
            "WITH data AS ({}) SELECT JSON_AGG(data.*) as ret FROM data;",
            validated_query
        );

        let ret = sqlx::query_as::<_, JsonRow>(&prepared_query)
            .fetch_one(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok(serde_json::to_string(&ret.ret)?)
    }

    pub(crate) async fn insert(&self, id: &str, query: &str) -> Result<String, PgMcpError> {
        let operation = "insert (INSERT)";
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let validated_query = validate_sql(
            query,
            |stmt| matches!(stmt, Statement::Insert { .. }),
            "INSERT",
        )?;

        let result = sqlx::query(&validated_query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok(format!(
            "success, rows_affected: {}",
            result.rows_affected()
        ))
    }

    pub(crate) async fn update(&self, id: &str, query: &str) -> Result<String, PgMcpError> {
        let operation = "update (UPDATE)";
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let validated_query = validate_sql(
            query,
            |stmt| matches!(stmt, Statement::Update { .. }),
            "UPDATE",
        )?;

        let result = sqlx::query(&validated_query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok(format!(
            "success, rows_affected: {}",
            result.rows_affected()
        ))
    }

    pub(crate) async fn delete(&self, id: &str, query: &str) -> Result<String, PgMcpError> {
        let operation = "delete (DELETE)";
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let validated_query = validate_sql(
            query,
            |stmt| matches!(stmt, Statement::Delete { .. }),
            "DELETE",
        )?;

        let result = sqlx::query(&validated_query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok(format!(
            "success, rows_affected: {}",
            result.rows_affected()
        ))
    }

    pub(crate) async fn create_table(&self, id: &str, query: &str) -> Result<String, PgMcpError> {
        let operation = "create_table (CREATE TABLE)";
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let validated_query = validate_sql(
            query,
            |stmt| matches!(stmt, Statement::CreateTable { .. }),
            "CREATE TABLE",
        )?;

        sqlx::query(&validated_query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok("success".to_string())
    }

    pub(crate) async fn drop_table(&self, id: &str, table: &str) -> Result<String, PgMcpError> {
        let operation = format!("drop_table (DROP TABLE {})", table);
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let query = format!("DROP TABLE {}", table);
        sqlx::query(&query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation,
                underlying: e.to_string(),
            })?;

        Ok("success".to_string())
    }

    pub(crate) async fn create_index(&self, id: &str, query: &str) -> Result<String, PgMcpError> {
        let operation = "create_index (CREATE INDEX)";
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let validated_query = validate_sql(
            query,
            |stmt| matches!(stmt, Statement::CreateIndex { .. }),
            "CREATE INDEX",
        )?;

        sqlx::query(&validated_query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok("success".to_string())
    }

    pub(crate) async fn drop_index(&self, id: &str, index: &str) -> Result<String, PgMcpError> {
        let operation = format!("drop_index (DROP INDEX {})", index);
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let query = format!("DROP INDEX {}", index);
        sqlx::query(&query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation,
                underlying: e.to_string(),
            })?;

        Ok("success".to_string())
    }

    pub(crate) async fn describe(&self, id: &str, table: &str) -> Result<String, PgMcpError> {
        let operation = format!("describe (table: {})", table);
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let query = r#"
        WITH data AS (
          SELECT column_name, data_type, character_maximum_length, column_default, is_nullable
          FROM information_schema.columns
          WHERE table_name = $1
          ORDER BY ordinal_position)
        SELECT JSON_AGG(data.*) as ret FROM data"#;

        let ret = sqlx::query_as::<_, JsonRow>(query)
            .bind(table)
            .fetch_one(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok(serde_json::to_string(&ret.ret)?)
    }

    pub(crate) async fn list_tables(&self, id: &str, schema: &str) -> Result<String, PgMcpError> {
        let operation = format!("list_tables (schema: {})", schema);
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let query = r#"
        WITH data AS (
          SELECT
                t.table_name,
                obj_description(format('%s.%s', t.table_schema, t.table_name)::regclass::oid) as description,
                pg_stat_get_tuples_inserted(format('%s.%s', t.table_schema, t.table_name)::regclass::oid) as total_rows
            FROM information_schema.tables t
            WHERE
                t.table_schema = $1
                AND t.table_type = 'BASE TABLE'
            ORDER BY t.table_name
        )
        SELECT JSON_AGG(data.*) as ret FROM data"#;
        let ret = sqlx::query_as::<_, JsonRow>(query)
            .bind(schema)
            .fetch_one(&conn.pool)
            .await
            .or_else(|e| {
                if let sqlx::Error::RowNotFound = e {
                    Ok(JsonRow {
                        ret: sqlx::types::Json(serde_json::json!([])),
                    })
                } else {
                    Err(PgMcpError::DatabaseError {
                        operation: operation.to_string(),
                        underlying: e.to_string(),
                    })
                }
            })?;

        Ok(serde_json::to_string(&ret.ret)?)
    }

    pub(crate) async fn create_schema(
        &self,
        id: &str,
        schema_name: &str,
    ) -> Result<String, PgMcpError> {
        let operation = format!("create_schema (CREATE SCHEMA {})", schema_name);
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let query = format!("CREATE SCHEMA {}", schema_name);
        sqlx::query(&query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation,
                underlying: e.to_string(),
            })?;

        Ok("success".to_string())
    }

    pub(crate) async fn create_type(&self, id: &str, query: &str) -> Result<String, PgMcpError> {
        let operation = "create_type (CREATE TYPE)";
        let conns = self.inner.load();
        let conn = conns
            .get(id)
            .ok_or_else(|| PgMcpError::ConnectionNotFound(id.to_string()))?;

        let validated_query = validate_sql(
            query,
            |stmt| matches!(stmt, Statement::CreateType { .. }),
            "CREATE TYPE",
        )?;

        sqlx::query(&validated_query)
            .execute(&conn.pool)
            .await
            .map_err(|e| PgMcpError::DatabaseError {
                operation: operation.to_string(),
                underlying: e.to_string(),
            })?;

        Ok("success".to_string())
    }
}

impl Default for Conns {
    fn default() -> Self {
        Self::new()
    }
}

fn validate_sql<F>(
    query: &str,
    validator: F,
    expected_type: &'static str,
) -> Result<String, PgMcpError>
where
    F: Fn(&Statement) -> bool,
{
    let dialect = sqlparser::dialect::PostgreSqlDialect {};
    let statements = sqlparser::parser::Parser::parse_sql(&dialect, query).map_err(|e| {
        PgMcpError::ValidationFailed {
            kind: ValidationErrorKind::ParseError,
            query: query.to_string(),
            details: e.to_string(),
        }
    })?;

    if statements.len() != 1 {
        return Err(PgMcpError::ValidationFailed {
            kind: ValidationErrorKind::InvalidStatementType {
                expected: expected_type.to_string(),
            },
            query: query.to_string(),
            details: format!(
                "Expected exactly one SQL statement, found {}",
                statements.len()
            ),
        });
    }

    let stmt = &statements[0];
    if !validator(stmt) {
        return Err(PgMcpError::ValidationFailed {
            kind: ValidationErrorKind::InvalidStatementType {
                expected: expected_type.to_string(),
            },
            query: query.to_string(),
            details: format!("Statement type validation failed. Received: {:?}", stmt),
        });
    }

    Ok(query.to_string())
}

#[cfg(test)]
mod tests {
    use super::*;
    use sqlx_db_tester::TestPg;

    const TEST_CONN_STR: &str = "postgres://postgres:postgres@localhost:5432/postgres";

    async fn setup_test_db() -> (TestPg, String) {
        let tdb = TestPg::new(
            TEST_CONN_STR.to_string(),
            std::path::Path::new("./fixtures/migrations"),
        );
        let pool = tdb.get_pool().await;

        sqlx::query("SELECT * FROM test_table LIMIT 1")
            .execute(&pool)
            .await
            .unwrap();

        let conn_str = tdb.url();

        (tdb, conn_str)
    }

    #[tokio::test]
    async fn register_unregister_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();

        let id = conns.register(conn_str.clone()).await.unwrap();
        assert!(!id.is_empty());

        assert!(conns.unregister(id.clone()).is_ok());
        assert!(conns.unregister(id).is_err());
    }

    #[tokio::test]
    async fn list_tables_describe_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();
        let id = conns.register(conn_str).await.unwrap();

        let tables = conns.list_tables(&id, "public").await.unwrap();
        assert!(tables.contains("test_table"));

        let description = conns.describe(&id, "test_table").await.unwrap();
        assert!(description.contains("id"));
        assert!(description.contains("name"));
        assert!(description.contains("created_at"));
    }

    #[tokio::test]
    async fn create_table_drop_table_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();
        let id = conns.register(conn_str).await.unwrap();

        let create_table = "CREATE TABLE test_table2 (id SERIAL PRIMARY KEY, name TEXT)";
        assert_eq!(
            conns.create_table(&id, create_table).await.unwrap(),
            "success"
        );

        assert_eq!(
            conns.drop_table(&id, "test_table2").await.unwrap(),
            "success"
        );

        assert!(conns.drop_table(&id, "test_table2").await.is_err());
    }

    #[tokio::test]
    async fn query_insert_update_delete_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();
        let id = conns.register(conn_str).await.unwrap();

        let query = "SELECT * FROM test_table ORDER BY id";
        let result = conns.query(&id, query).await.unwrap();
        assert!(result.contains("test1"));
        assert!(result.contains("test2"));
        assert!(result.contains("test3"));

        let insert = "INSERT INTO test_table (name) VALUES ('test4')";
        let result = conns.insert(&id, insert).await.unwrap();
        assert!(result.contains("rows_affected: 1"));

        let update = "UPDATE test_table SET name = 'updated' WHERE name = 'test1'";
        let result = conns.update(&id, update).await.unwrap();
        assert!(result.contains("rows_affected: 1"));

        let result = conns
            .delete(&id, "DELETE FROM test_table WHERE name = 'updated'")
            .await
            .unwrap();
        assert!(result.contains("rows_affected: 1"));
    }

    #[tokio::test]
    async fn create_index_drop_index_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();
        let id = conns.register(conn_str).await.unwrap();

        let create_index = "CREATE INDEX idx_test_table_new ON test_table (name, created_at)";
        assert_eq!(
            conns.create_index(&id, create_index).await.unwrap(),
            "success"
        );

        assert_eq!(
            conns.drop_index(&id, "idx_test_table_new").await.unwrap(),
            "success"
        );
    }

    #[tokio::test]
    async fn sql_validation_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();
        let id = conns.register(conn_str).await.unwrap();

        let invalid_query = "INSERT INTO test_table VALUES (1)";
        assert!(conns.query(&id, invalid_query).await.is_err());

        let invalid_insert = "SELECT * FROM test_table";
        assert!(conns.insert(&id, invalid_insert).await.is_err());

        let invalid_update = "DELETE FROM test_table";
        assert!(conns.update(&id, invalid_update).await.is_err());

        let invalid_create = "CREATE INDEX idx_test ON test_table (id)";
        assert!(conns.create_table(&id, invalid_create).await.is_err());

        let invalid_index = "CREATE TABLE test (id INT)";
        assert!(conns.create_index(&id, invalid_index).await.is_err());
    }

    #[tokio::test]
    async fn create_type_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();
        let id = conns.register(conn_str).await.unwrap();

        let create_type = "CREATE TYPE user_role AS ENUM ('admin', 'user')";
        assert_eq!(
            conns.create_type(&id, create_type).await.unwrap(),
            "success"
        );

        let invalid_type = "CREATE TABLE test (id INT)";
        assert!(conns.create_type(&id, invalid_type).await.is_err());
    }

    #[tokio::test]
    async fn create_schema_should_work() {
        let (_tdb, conn_str) = setup_test_db().await;
        let conns = Conns::new();
        let id = conns.register(conn_str).await.unwrap();

        let schema_name = "test_schema_unit";
        assert_eq!(
            conns.create_schema(&id, schema_name).await.unwrap(),
            "success"
        );

        let query = format!(
            "SELECT schema_name FROM information_schema.schemata WHERE schema_name = '{}'",
            schema_name
        );
        let _result = sqlx::query(&query)
            .fetch_one(&conns.inner.load().get(&id).unwrap().pool)
            .await
            .unwrap();

        let invalid_schema_name = "test;schema";
        assert!(conns.create_schema(&id, invalid_schema_name).await.is_err());
    }
}