Skip to main content

dbmcp_sqlite/tools/
list_views.rs

1//! MCP tool: `listViews`.
2
3use dbmcp_server::pagination::Pager;
4use dbmcp_server::types::ListEntriesResponse;
5
6use super::prelude::*;
7use crate::types::ListViewsRequest;
8
9const NAME: &str = "listViews";
10const TITLE: &str = "List Views";
11const DESCRIPTION: &str = include_str!("../../assets/tools/list_views.md");
12
13/// Marker type for the `listViews` MCP tool.
14pub(crate) struct ListViewsTool;
15
16impl ToolBase for ListViewsTool {
17    type Parameter = ListViewsRequest;
18    type Output = ListEntriesResponse;
19    type Error = ErrorData;
20
21    fn name() -> Cow<'static, str> {
22        NAME.into()
23    }
24
25    fn title() -> Option<String> {
26        Some(TITLE.into())
27    }
28
29    fn description() -> Option<Cow<'static, str>> {
30        Some(DESCRIPTION.into())
31    }
32
33    fn input_schema() -> Option<Arc<JsonObject>> {
34        None
35    }
36
37    fn output_schema() -> Option<Arc<JsonObject>> {
38        Some(output_schema::<Self::Output>())
39    }
40
41    fn annotations() -> Option<ToolAnnotations> {
42        Some(
43            ToolAnnotations::new()
44                .read_only(true)
45                .destructive(false)
46                .idempotent(true)
47                .open_world(false),
48        )
49    }
50}
51
52impl AsyncTool<SqliteHandler> for ListViewsTool {
53    async fn invoke(handler: &SqliteHandler, params: Self::Parameter) -> Result<Self::Output, Self::Error> {
54        handler.list_views(params).await
55    }
56}
57
58impl SqliteHandler {
59    /// Lists one page of views in the connected database.
60    ///
61    /// # Errors
62    ///
63    /// Returns [`ErrorData`] with code `-32602` if `cursor` is malformed,
64    /// or an internal-error [`ErrorData`] if the underlying query fails.
65    pub async fn list_views(
66        &self,
67        ListViewsRequest { cursor }: ListViewsRequest,
68    ) -> Result<ListEntriesResponse, ErrorData> {
69        let pager = Pager::new(cursor, self.config.page_size);
70        let query = format!(
71            r"
72            SELECT name
73            FROM sqlite_schema
74            WHERE type = 'view' AND name NOT LIKE 'sqlite_%'
75            ORDER BY name
76            LIMIT {} OFFSET {}",
77            pager.limit(),
78            pager.offset(),
79        );
80
81        let rows: Vec<String> = self.connection.fetch_scalar(query.as_str(), None).await?;
82        let (views, next_cursor) = pager.paginate(rows);
83
84        Ok(ListEntriesResponse::brief(views, next_cursor))
85    }
86}