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
use anyhow::Result;
use rmcp::{
    RoleClient, ServiceExt, model::CallToolRequestParam, object, service::RunningService,
    transport::TokioChildProcess,
};
use sqlx_db_tester::TestPg;
use tokio::process::Command;

type McpService = RunningService<RoleClient, ()>;

#[allow(dead_code)]
struct TestService {
    tdb: TestPg,
    conn_id: String,
    service: McpService,
}

const TEST_CONN_STR: &str = "postgres://postgres:postgres@localhost:5432/postgres";
async fn setup_service() -> Result<TestService> {
    // use TestPg
    let tdb = TestPg::new(
        TEST_CONN_STR.to_string(),
        std::path::Path::new("./fixtures/migrations"),
    );
    let url = tdb.url();

    let mut cmd = Command::new("postgres-mcp");
    cmd.arg("stdio");
    let service = ().serve(TokioChildProcess::new(&mut cmd)?).await?;

    // Register a test connection
    let tool_result = service
        .call_tool(CallToolRequestParam {
            name: "register".into(),
            arguments: Some(object!({
                "conn_str": url
            })),
        })
        .await?;

    let conn_id = tool_result.content[0].raw.as_text().unwrap().text.clone();
    Ok(TestService {
        tdb,
        conn_id,
        service,
    })
}

async fn cleanup_service(service: McpService, conn_id: impl AsRef<str>) -> Result<()> {
    // Unregister the connection
    service
        .call_tool(CallToolRequestParam {
            name: "unregister".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_ref()
            })),
        })
        .await?;

    service.cancel().await?;
    Ok(())
}

#[tokio::test]
async fn test_connection_management() -> Result<()> {
    let test_service = setup_service().await?;
    let service = test_service.service;
    let conn_id = test_service.conn_id;

    // Test listing tables in public schema
    let tool_result = service
        .call_tool(CallToolRequestParam {
            name: "list_tables".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "schema": "public"
            })),
        })
        .await?;
    assert!(!tool_result.content.is_empty());

    cleanup_service(service, &conn_id).await?;
    Ok(())
}

#[tokio::test]
async fn test_table_operations() -> Result<()> {
    let test_service = setup_service().await?;
    let service = test_service.service;
    let conn_id = test_service.conn_id;

    // Create test table
    let create_result = service
        .call_tool(CallToolRequestParam {
            name: "create_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "CREATE TABLE IF NOT EXISTS test_users (id SERIAL PRIMARY KEY, name TEXT NOT NULL, email TEXT UNIQUE NOT NULL)"
            })),
        })
        .await?;
    assert!(!create_result.content.is_empty());

    // Describe the table
    let describe_result = service
        .call_tool(CallToolRequestParam {
            name: "describe".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "table": "test_users"
            })),
        })
        .await?;
    assert!(!describe_result.content.is_empty());

    // Drop the table
    let drop_result = service
        .call_tool(CallToolRequestParam {
            name: "drop_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "table": "test_users"
            })),
        })
        .await?;
    assert!(!drop_result.content.is_empty());

    cleanup_service(service, &conn_id).await?;
    Ok(())
}

#[tokio::test]
async fn test_data_operations() -> Result<()> {
    let test_service = setup_service().await?;
    let service = test_service.service;
    let conn_id = test_service.conn_id;

    // Create test table
    service
        .call_tool(CallToolRequestParam {
            name: "create_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "CREATE TABLE IF NOT EXISTS test_users (id SERIAL PRIMARY KEY, name TEXT NOT NULL, email TEXT UNIQUE NOT NULL)"
            })),
        })
        .await?;

    // Insert data
    let insert_result = service
        .call_tool(CallToolRequestParam {
            name: "insert".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "INSERT INTO test_users (name, email) VALUES ('Test User', 'test@example.com')"
            })),
        })
        .await?;
    assert!(!insert_result.content.is_empty());

    // Query data
    let query_result = service
        .call_tool(CallToolRequestParam {
            name: "query".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "SELECT * FROM test_users WHERE email = 'test@example.com'"
            })),
        })
        .await?;
    assert!(!query_result.content.is_empty());

    // Update data
    let update_result = service
        .call_tool(CallToolRequestParam {
            name: "update".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "UPDATE test_users SET name = 'Updated User' WHERE email = 'test@example.com'"
            })),
        })
        .await?;
    assert!(!update_result.content.is_empty());

    // Delete data
    let delete_result = service
        .call_tool(CallToolRequestParam {
            name: "delete".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "DELETE FROM test_users WHERE email = 'test@example.com'"
            })),
        })
        .await?;
    assert!(!delete_result.content.is_empty());

    // Drop the test table
    service
        .call_tool(CallToolRequestParam {
            name: "drop_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "table": "test_users"
            })),
        })
        .await?;

    cleanup_service(service, &conn_id).await?;
    Ok(())
}

#[tokio::test]
async fn test_index_operations() -> Result<()> {
    let test_service = setup_service().await?;
    let service = test_service.service;
    let conn_id = test_service.conn_id;

    // Create test table
    service
        .call_tool(CallToolRequestParam {
            name: "create_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "CREATE TABLE IF NOT EXISTS test_users (id SERIAL PRIMARY KEY, name TEXT NOT NULL, email TEXT UNIQUE NOT NULL)"
            })),
        })
        .await?;

    // Create index
    let create_index_result = service
        .call_tool(CallToolRequestParam {
            name: "create_index".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "CREATE INDEX idx_test_users_email ON test_users (email)"
            })),
        })
        .await?;
    assert!(!create_index_result.content.is_empty());

    // Drop index
    let drop_index_result = service
        .call_tool(CallToolRequestParam {
            name: "drop_index".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "index": "idx_test_users_email"
            })),
        })
        .await?;
    assert!(!drop_index_result.content.is_empty());

    // Drop the test table
    service
        .call_tool(CallToolRequestParam {
            name: "drop_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "table": "test_users"
            })),
        })
        .await?;

    cleanup_service(service, &conn_id).await?;
    Ok(())
}

#[tokio::test]
async fn test_type_operations() -> Result<()> {
    let test_service = setup_service().await?;
    let service = test_service.service;
    let conn_id = test_service.conn_id;

    // Create enum type
    let create_type_result = service
        .call_tool(CallToolRequestParam {
            name: "create_type".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "CREATE TYPE user_role AS ENUM ('admin', 'user', 'guest')"
            })),
        })
        .await?;
    assert!(!create_type_result.content.is_empty());

    // Create a table using the new type
    let create_table_result = service
        .call_tool(CallToolRequestParam {
            name: "create_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "CREATE TABLE test_users (id SERIAL PRIMARY KEY, name TEXT NOT NULL, role user_role NOT NULL)"
            })),
        })
        .await?;
    assert!(!create_table_result.content.is_empty());

    // Insert data using the enum type
    let insert_result = service
        .call_tool(CallToolRequestParam {
            name: "insert".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "INSERT INTO test_users (name, role) VALUES ('Test Admin', 'admin'), ('Test User', 'user'), ('Test Guest', 'guest')"
            })),
        })
        .await?;
    assert!(!insert_result.content.is_empty());

    // Query data to verify enum type works
    let query_result = service
        .call_tool(CallToolRequestParam {
            name: "query".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "SELECT * FROM test_users WHERE role = 'admin'"
            })),
        })
        .await?;
    assert!(!query_result.content.is_empty());

    // Drop the test table
    service
        .call_tool(CallToolRequestParam {
            name: "drop_table".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "table": "test_users"
            })),
        })
        .await?;

    cleanup_service(service, &conn_id).await?;
    Ok(())
}

#[tokio::test]
async fn test_schema_operations() -> Result<()> {
    let test_service = setup_service().await?;
    let service = test_service.service;
    let conn_id = test_service.conn_id;

    // Create a test schema
    let name = "test_schema_ops";
    let create_result = service
        .call_tool(CallToolRequestParam {
            name: "create_schema".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "name": name
            })),
        })
        .await?;
    assert!(
        create_result.content[0]
            .raw
            .as_text()
            .unwrap()
            .text
            .contains("success")
    );

    cleanup_service(service, &conn_id).await?;
    Ok(())
}

#[tokio::test]
async fn test_error_scenarios() -> Result<()> {
    let test_service = setup_service().await?;
    let service = test_service.service;
    let conn_id = test_service.conn_id;
    let invalid_conn_id = "invalid-uuid";

    // --- Test Connection Not Found ---
    let result = service
        .call_tool(CallToolRequestParam {
            name: "query".into(),
            arguments: Some(object!({
                "conn_id": invalid_conn_id, // Use invalid ID
                "query": "SELECT 1"
            })),
        })
        .await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    // Check if the error message contains the invalid ID
    // eprintln!("Actual error string: {}", err.to_string()); // Removed debug print
    assert!(
        err.to_string().contains("onnection not found") // Match actual stdio transport error
    );
    // assert!(err.to_string().contains(invalid_conn_id)); // The ID isn't in the generic message

    // --- Test SQL Validation Errors ---

    // 1. Invalid Statement Type
    let result = service
        .call_tool(CallToolRequestParam {
            name: "query".into(), // Expects SELECT
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "INSERT INTO non_existent_table (col) VALUES (1)" // Provide INSERT
            })),
        })
        .await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    // Assuming validation errors also map to -32603 or similar - need to verify if this fails
    assert!(
        err.to_string().contains("-32603") || err.to_string().contains("SQL validation failed")
    ); // Looser check for now

    // 2. Parse Error (Invalid Syntax)
    let result = service
        .call_tool(CallToolRequestParam {
            name: "query".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "SELECT * FROM test_table WHERE id = " // Incomplete query
            })),
        })
        .await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    // Assuming validation errors also map to -32603 or similar
    assert!(
        err.to_string().contains("-32603") || err.to_string().contains("SQL validation failed")
    ); // Looser check for now

    // 3. Multiple Statements
    let result = service
        .call_tool(CallToolRequestParam {
            name: "query".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "SELECT 1; SELECT 2;"
            })),
        })
        .await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    // Assuming validation errors also map to -32603 or similar
    assert!(
        err.to_string().contains("-32603") || err.to_string().contains("SQL validation failed")
    ); // Looser check for now

    // --- Test Database Errors (Example: Table not found) ---
    let result = service
        .call_tool(CallToolRequestParam {
            name: "query".into(),
            arguments: Some(object!({
                "conn_id": conn_id.as_str(),
                "query": "SELECT * FROM non_existent_table"
            })),
        })
        .await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    // Assuming database errors also map to -32603 or similar
    assert!(err.to_string().contains("-32603") || err.to_string().contains("Database operation")); // Looser check for now

    // --- Test Unregister Invalid ID ---
    let result = service
        .call_tool(CallToolRequestParam {
            name: "unregister".into(),
            arguments: Some(object!({
                "conn_id": invalid_conn_id,
            })),
        })
        .await;
    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(
        err.to_string().contains("Connection not found") // Match actual stdio transport error
    );
    // assert!(err.to_string().contains(invalid_conn_id)); // The ID isn't in the generic message

    cleanup_service(service, &conn_id).await?;
    Ok(())
}