nexql-tools 0.4.2

MCP tool registry, JSON schemas, executors
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
659
660
661
662
663
664
665
666
667
668
669
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 NexQL-OSS Team

//! Session state: resolved profiles + active pool + optional schema index.

use std::collections::{HashMap, HashSet};
use std::path::{Path, PathBuf};
use std::sync::{Arc, RwLock};

use deadpool_postgres::{Object, Pool};
use nexql_conn::{
    ConnectionParams, PoolOptions, ProfileConfig, ResolvedConnection, checkout_guarded, create_pool,
    resolve_profile,
};
use nexql_index::IndexStore;
use nexql_policy::{AccessMode, PolicyCaps, PolicyFilter, clamp_statement_timeout_ms};
use tokio::sync::RwLock as AsyncRwLock;

use crate::error::ToolError;

/// Index root: `NEXQL_MCP_INDEX_DIR`, else `~/.local/share/nexql-mcp` (same as CLI).
pub fn default_index_root() -> PathBuf {
    if let Ok(p) = std::env::var("NEXQL_MCP_INDEX_DIR") {
        return PathBuf::from(p);
    }
    let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
    PathBuf::from(home).join(".local/share/nexql-mcp")
}

/// Determine index root with workspace override support.
/// Priority: explicit env var → project config index_dir → global default.
pub fn resolve_index_root(
    workspace_root: Option<&Path>,
    project_config: Option<&nexql_conn::ProjectConfigFile>,
) -> PathBuf {
    if let Ok(p) = std::env::var("NEXQL_MCP_INDEX_DIR") {
        return PathBuf::from(p);
    }
    if let (Some(root), Some(cfg)) = (workspace_root, project_config)
        && let Some(ref index_dir) = cfg.index_dir
    {
        return root.join(".nexql").join(index_dir);
    }
    default_index_root()
}

#[derive(Debug, Clone)]
pub struct ConnectionPolicy {
    pub access_mode: AccessMode,
    pub caps: PolicyCaps,
    pub filter: PolicyFilter,
    pub environment: Option<String>,
}

#[derive(Debug, Clone)]
pub struct ConnectionInfo {
    pub id: String,
    pub name: String,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub database: Option<String>,
    pub params: ConnectionParams,
    pub policy: ConnectionPolicy,
}

#[derive(Debug, Clone)]
struct ActivePolicy {
    access_mode: AccessMode,
    caps: PolicyCaps,
    filter: PolicyFilter,
    pool_opts: PoolOptions,
}

pub struct ToolSession {
    connections: RwLock<Vec<ConnectionInfo>>,
    /// `connection_id\0database` keys marked stale after DDL until index rebuild/refresh.
    stale_index_keys: RwLock<HashSet<String>>,
    policy: RwLock<ActivePolicy>,
    /// Schema index root; `None` disables Phase 3 tools with an actionable error.
    pub index_store: Option<IndexStore>,
    inner: AsyncRwLock<SessionInner>,
}

fn filter_from_profile(profile: &ProfileConfig) -> PolicyFilter {
    PolicyFilter {
        allow_schemas: profile.schemas.clone(),
        deny_schemas: profile.deny_schemas.clone(),
        deny_tables: profile.deny_tables.clone(),
        pii_columns: profile.pii_columns.clone(),
    }
}

pub fn policy_from_profile(
    profile: Option<&ProfileConfig>,
    default_mode: AccessMode,
    default_caps: PolicyCaps,
) -> ConnectionPolicy {
    let access_mode = profile
        .and_then(|p| p.access_mode.as_deref())
        .and_then(|m| m.parse::<AccessMode>().ok())
        .unwrap_or(default_mode);
    let mut caps = default_caps;
    if let Some(n) = profile.and_then(|p| p.max_rows) {
        caps = caps.with_max_rows(n);
    }
    if let Some(ms) = profile.and_then(|p| p.statement_timeout_ms) {
        caps = caps.with_statement_timeout_ms(ms);
    }
    let filter = profile.map(filter_from_profile).unwrap_or_default();
    ConnectionPolicy {
        access_mode,
        caps,
        filter,
        environment: None,
    }
}

struct SessionInner {
    active_id: String,
    database: String,
    pools: HashMap<String, Pool>,
}

fn pool_key(connection_id: &str, database: &str) -> String {
    format!("{connection_id}\0{database}")
}

fn params_for_database(base: &ConnectionParams, database: &str) -> ConnectionParams {
    let mut params = base.clone();
    params.dbname = Some(database.to_string());
    // `to_url()` prefers `url` over `dbname`; drop stale URL path when host fields exist.
    if params.host.is_some() {
        params.url = None;
    }
    params
}

fn active_policy_from(policy: &ConnectionPolicy) -> ActivePolicy {
    ActivePolicy {
        access_mode: policy.access_mode,
        caps: policy.caps.clone(),
        filter: policy.filter.clone(),
        pool_opts: PoolOptions {
            read_only: !policy.access_mode.allows_writes(),
            statement_timeout: std::time::Duration::from_millis(
                policy.caps.statement_timeout_ms as u64,
            ),
            ..Default::default()
        },
    }
}

/// Target connection/database for a single tool call without mutating session context.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ScopedContext {
    pub connection_id: String,
    pub database: String,
}

/// Checkout target: active session or an explicit scoped context.
pub enum CheckoutTarget<'a> {
    Active,
    Scoped(&'a ScopedContext),
}

impl ToolSession {
    pub fn connections(&self) -> Vec<ConnectionInfo> {
        self.connections
            .read()
            .map(|c| c.clone())
            .unwrap_or_default()
    }

    /// Register or update a profile in the live session (after save/import/setup).
    pub fn register_profile(
        &self,
        name: &str,
        profile: &ProfileConfig,
        default_mode: AccessMode,
        default_caps: PolicyCaps,
    ) -> Result<(), ToolError> {
        let params = resolve_profile(name, profile).map_err(ToolError::Conn)?;
        let policy = policy_from_profile(Some(profile), default_mode, default_caps);
        let info = ConnectionInfo {
            id: name.to_string(),
            name: name.to_string(),
            host: params.host.clone(),
            port: params.port,
            database: params.dbname.clone(),
            params,
            policy,
        };
        let mut conns = self
            .connections
            .write()
            .map_err(|_| ToolError::Execution("connection registry lock poisoned".into()))?;
        if let Some(existing) = conns.iter_mut().find(|c| c.id == name) {
            *existing = info;
        } else {
            conns.push(info);
        }
        Ok(())
    }

    pub fn mark_index_stale(&self, connection_id: &str, database: &str) {
        let key = pool_key(connection_id, database);
        if let Ok(mut keys) = self.stale_index_keys.write() {
            keys.insert(key);
        }
    }

    pub fn clear_index_stale(&self, connection_id: &str, database: &str) {
        let key = pool_key(connection_id, database);
        if let Ok(mut keys) = self.stale_index_keys.write() {
            keys.remove(&key);
        }
    }

    pub fn is_index_stale(&self, connection_id: &str, database: &str) -> bool {
        let key = pool_key(connection_id, database);
        self.stale_index_keys
            .read()
            .map(|keys| keys.contains(&key))
            .unwrap_or(false)
    }

    pub fn access_mode(&self) -> AccessMode {
        self.policy
            .read()
            .map(|p| p.access_mode)
            .unwrap_or(AccessMode::Read)
    }

    pub fn caps(&self) -> PolicyCaps {
        self.policy
            .read()
            .map(|p| p.caps.clone())
            .unwrap_or_default()
    }

    pub fn filter(&self) -> PolicyFilter {
        self.policy
            .read()
            .map(|p| p.filter.clone())
            .unwrap_or_default()
    }

    pub fn pool_opts(&self) -> PoolOptions {
        self.policy
            .read()
            .map(|p| p.pool_opts.clone())
            .unwrap_or_default()
    }

    fn apply_policy(&self, policy: &ConnectionPolicy) {
        if let Ok(mut active) = self.policy.write() {
            *active = active_policy_from(policy);
        }
    }

    pub async fn from_resolved(
        resolved: ResolvedConnection,
        access_mode: AccessMode,
        caps: PolicyCaps,
    ) -> Result<Arc<Self>, ToolError> {
        let id = resolved
            .profile_name
            .clone()
            .unwrap_or_else(|| "default".into());
        let conn_policy = policy_from_profile(resolved.profile.as_ref(), access_mode, caps);
        let info = ConnectionInfo {
            id: id.clone(),
            name: id.clone(),
            host: resolved.params.host.clone(),
            port: resolved.params.port,
            database: resolved.params.dbname.clone(),
            params: resolved.params,
            policy: conn_policy,
        };
        Self::from_connections(vec![info], Some(id)).await
    }

    pub async fn from_connections(
        connections: Vec<ConnectionInfo>,
        active_id: Option<String>,
    ) -> Result<Arc<Self>, ToolError> {
        if connections.is_empty() {
            return Err(ToolError::Execution("no connections configured".into()));
        }
        let active = active_id.unwrap_or_else(|| connections[0].id.clone());
        let active_conn = connections
            .iter()
            .find(|c| c.id == active)
            .unwrap_or(&connections[0]);
        let active_policy = active_policy_from(&active_conn.policy);
        let pool_opts = active_policy.pool_opts.clone();
        let mut pools = HashMap::new();
        for c in &connections {
            let database = c.database.as_deref().unwrap_or("postgres");
            let pool = create_pool(&c.params, &pool_opts).await?;
            pools.insert(pool_key(&c.id, database), pool);
        }
        let database = active_conn
            .database
            .clone()
            .unwrap_or_else(|| "postgres".into());
        Ok(Arc::new(Self {
            connections: RwLock::new(connections),
            stale_index_keys: RwLock::new(HashSet::new()),
            policy: RwLock::new(active_policy),
            index_store: Some(IndexStore::new(default_index_root())),
            inner: AsyncRwLock::new(SessionInner {
                active_id: active,
                database,
                pools,
            }),
        }))
    }

    pub async fn from_connections_with_filter(
        connections: Vec<ConnectionInfo>,
        access_mode: AccessMode,
        caps: PolicyCaps,
        active_id: Option<String>,
        filter: PolicyFilter,
    ) -> Result<Arc<Self>, ToolError> {
        let connections = connections
            .into_iter()
            .map(|mut c| {
                c.policy.access_mode = access_mode;
                c.policy.caps = caps.clone();
                c.policy.filter = filter.clone();
                c
            })
            .collect();
        Self::from_connections(connections, active_id).await
    }

    pub async fn active_context(&self) -> (String, String) {
        let g = self.inner.read().await;
        (g.active_id.clone(), g.database.clone())
    }

    pub async fn switch(
        &self,
        connection_id: &str,
        database: Option<String>,
    ) -> Result<(), ToolError> {
        let conn = self
            .connections()
            .into_iter()
            .find(|c| c.id == connection_id)
            .ok_or_else(|| {
                ToolError::Execution(format!(
                    "Connection not found for ID: {connection_id} — call list_connections"
                ))
            })?;
        let target_db = database
            .or_else(|| conn.database.clone())
            .unwrap_or_else(|| "postgres".into());
        self.apply_policy(&conn.policy);
        let pool_opts = self.pool_opts();
        let key = pool_key(connection_id, &target_db);
        let mut g = self.inner.write().await;
        if let std::collections::hash_map::Entry::Vacant(e) = g.pools.entry(key) {
            let params = params_for_database(&conn.params, &target_db);
            let pool = create_pool(&params, &pool_opts).await?;
            e.insert(pool);
        }
        g.active_id = connection_id.to_string();
        g.database = target_db;
        Ok(())
    }

    pub async fn checkout(&self) -> Result<Object, ToolError> {
        let g = self.inner.read().await;
        let key = pool_key(&g.active_id, &g.database);
        let pool = g
            .pools
            .get(&key)
            .ok_or_else(|| ToolError::Execution("no active pool".into()))?;
        let pool_opts = self.pool_opts();
        Ok(checkout_guarded(pool, &pool_opts).await?)
    }

    pub fn connection_policy(&self, connection_id: &str) -> Option<ConnectionPolicy> {
        self.connections()
            .into_iter()
            .find(|c| c.id == connection_id)
            .map(|c| c.policy.clone())
    }

    pub fn filter_for(&self, connection_id: &str) -> PolicyFilter {
        self.connection_policy(connection_id)
            .map(|p| p.filter)
            .unwrap_or_else(|| self.filter())
    }

    pub fn caps_for(&self, connection_id: &str) -> PolicyCaps {
        self.connection_policy(connection_id)
            .map(|p| p.caps)
            .unwrap_or_else(|| self.caps())
    }

    pub fn pool_opts_for(&self, connection_id: &str) -> PoolOptions {
        if let Some(policy) = self.connection_policy(connection_id) {
            PoolOptions {
                read_only: !policy.access_mode.allows_writes(),
                statement_timeout: std::time::Duration::from_millis(
                    policy.caps.statement_timeout_ms as u64,
                ),
                ..Default::default()
            }
        } else {
            self.pool_opts()
        }
    }

    /// Resolve effective connection/database for a tool call.
    pub async fn resolve_scoped_context(
        &self,
        connection_id: Option<&str>,
        database: Option<&str>,
    ) -> Result<ScopedContext, ToolError> {
        if let Some(id) = connection_id {
            let conn = self
                .connections()
                .into_iter()
                .find(|c| c.id == id)
                .ok_or_else(|| {
                    ToolError::Execution(format!(
                        "Connection not found for ID: {id} — call list_connections"
                    ))
                })?;
            let target_db = database
                .map(str::to_owned)
                .or_else(|| conn.database.clone())
                .unwrap_or_else(|| "postgres".into());
            Ok(ScopedContext {
                connection_id: id.to_string(),
                database: target_db,
            })
        } else {
            if database.is_some() {
                return Err(ToolError::InvalidArgs(
                    "database requires connectionId when overriding the active session".into(),
                ));
            }
            let (id, db) = self.active_context().await;
            Ok(ScopedContext {
                connection_id: id,
                database: db,
            })
        }
    }

    async fn ensure_pool_for(&self, ctx: &ScopedContext) -> Result<(), ToolError> {
        let conn = self
            .connections()
            .into_iter()
            .find(|c| c.id == ctx.connection_id)
            .ok_or_else(|| {
                ToolError::Execution(format!(
                    "Connection not found for ID: {} — call list_connections",
                    ctx.connection_id
                ))
            })?;
        let pool_opts = self.pool_opts_for(&ctx.connection_id);
        let key = pool_key(&ctx.connection_id, &ctx.database);
        let mut g = self.inner.write().await;
        if g.pools.contains_key(&key) {
            return Ok(());
        }
        let params = params_for_database(&conn.params, &ctx.database);
        let pool = create_pool(&params, &pool_opts).await?;
        g.pools.insert(key, pool);
        Ok(())
    }

    /// Checkout a client for the given target without changing active session context.
    pub async fn checkout_for(
        &self,
        target: CheckoutTarget<'_>,
    ) -> Result<(Object, ScopedContext), ToolError> {
        match target {
            CheckoutTarget::Active => {
                let (id, db) = self.active_context().await;
                let ctx = ScopedContext {
                    connection_id: id,
                    database: db,
                };
                Ok((self.checkout().await?, ctx))
            }
            CheckoutTarget::Scoped(ctx) => {
                self.ensure_pool_for(ctx).await?;
                let key = pool_key(&ctx.connection_id, &ctx.database);
                let pool = {
                    let g = self.inner.read().await;
                    g.pools
                        .get(&key)
                        .cloned()
                        .ok_or_else(|| ToolError::Execution("no pool for scoped context".into()))?
                };
                let pool_opts = self.pool_opts_for(&ctx.connection_id);
                let client = checkout_guarded(&pool, &pool_opts).await?;
                Ok((client, ctx.clone()))
            }
        }
    }

    pub async fn set_statement_timeout(
        client: &Object,
        timeout_ms: u32,
    ) -> Result<(), ToolError> {
        let ms = clamp_statement_timeout_ms(timeout_ms);
        client
            .batch_execute(&format!("SET statement_timeout = '{ms}ms'"))
            .await
            .map_err(|e| ToolError::Execution(e.to_string()))?;
        Ok(())
    }

    /// Test helper: session with no live pools (index tools only).
    #[cfg(test)]
    pub fn for_tests(
        connections: Vec<ConnectionInfo>,
        filter: PolicyFilter,
        index_store: Option<IndexStore>,
    ) -> Arc<Self> {
        assert!(!connections.is_empty());
        let active = connections[0].id.clone();
        let database = connections[0]
            .database
            .clone()
            .unwrap_or_else(|| "postgres".into());
        let policy = ConnectionPolicy {
            access_mode: AccessMode::Read,
            caps: PolicyCaps::default(),
            filter,
            environment: None,
        };
        Arc::new(Self {
            connections: RwLock::new(connections),
            stale_index_keys: RwLock::new(HashSet::new()),
            policy: RwLock::new(active_policy_from(&policy)),
            index_store,
            inner: AsyncRwLock::new(SessionInner {
                active_id: active,
                database,
                pools: HashMap::new(),
            }),
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use nexql_conn::ConnectionParams;

    #[test]
    fn filter_maps_profile_fields() {
        let profile = ProfileConfig {
            schemas: vec!["public".into()],
            deny_schemas: vec!["pgboss".into()],
            deny_tables: vec!["auth.*".into()],
            pii_columns: vec!["public.users.ssn".into()],
            ..Default::default()
        };
        let f = filter_from_profile(&profile);
        assert_eq!(f.allow_schemas, vec!["public"]);
        assert_eq!(f.deny_schemas, vec!["pgboss"]);
        assert_eq!(f.deny_tables, vec!["auth.*"]);
        assert_eq!(f.pii_columns, vec!["public.users.ssn"]);
        assert!(f.allows_schema("public"));
        assert!(!f.allows_schema("pgboss"));
        assert!(!f.allows_table("auth", "sessions"));
    }

    #[test]
    fn register_profile_upserts_connection() {
        let session = ToolSession::for_tests(
            vec![ConnectionInfo {
                id: "existing".into(),
                name: "existing".into(),
                host: Some("localhost".into()),
                port: Some(5432),
                database: Some("postgres".into()),
                params: ConnectionParams::default(),
                policy: policy_from_profile(None, AccessMode::Read, PolicyCaps::default()),
            }],
            PolicyFilter::default(),
            None,
        );
        let profile = ProfileConfig {
            host: Some("db.example.com".into()),
            port: Some(5432),
            dbname: Some("app".into()),
            user: Some("app".into()),
            password: Some("secret".into()),
            ..Default::default()
        };
        session
            .register_profile("newdb", &profile, AccessMode::Read, PolicyCaps::default())
            .unwrap();
        let names: Vec<_> = session.connections().iter().map(|c| c.id.clone()).collect();
        assert!(names.contains(&"existing".to_string()));
        assert!(names.contains(&"newdb".to_string()));
    }

    #[tokio::test]
    async fn checkout_for_scoped_does_not_change_active_context() {
        let session = ToolSession::for_tests(
            vec![
                ConnectionInfo {
                    id: "a".into(),
                    name: "a".into(),
                    host: Some("localhost".into()),
                    port: Some(5432),
                    database: Some("postgres".into()),
                    params: ConnectionParams::default(),
                    policy: policy_from_profile(None, AccessMode::Read, PolicyCaps::default()),
                },
                ConnectionInfo {
                    id: "b".into(),
                    name: "b".into(),
                    host: Some("localhost".into()),
                    port: Some(5432),
                    database: Some("postgres".into()),
                    params: ConnectionParams::default(),
                    policy: policy_from_profile(None, AccessMode::Read, PolicyCaps::default()),
                },
            ],
            PolicyFilter::default(),
            None,
        );
        let scoped = ScopedContext {
            connection_id: "b".into(),
            database: "postgres".into(),
        };
        let _ = session
            .checkout_for(CheckoutTarget::Scoped(&scoped))
            .await;
        let (active_id, _) = session.active_context().await;
        assert_eq!(active_id, "a");
    }

    #[test]
    fn index_stale_marker_round_trip() {
        let session = ToolSession::for_tests(
            vec![ConnectionInfo {
                id: "local".into(),
                name: "local".into(),
                host: None,
                port: None,
                database: Some("postgres".into()),
                params: ConnectionParams::default(),
                policy: policy_from_profile(None, AccessMode::Read, PolicyCaps::default()),
            }],
            PolicyFilter::default(),
            None,
        );
        assert!(!session.is_index_stale("local", "postgres"));
        session.mark_index_stale("local", "postgres");
        assert!(session.is_index_stale("local", "postgres"));
        session.clear_index_stale("local", "postgres");
        assert!(!session.is_index_stale("local", "postgres"));
    }
}