MCP SQLite Server

1# 🐇 MCP SQLite Server
2This is a Model Context Protocol (MCP) server that provides comprehensive SQLite database interaction capabilities.
3
4![cursor-settings](https://raw.githubusercontent.com/jparkerweb/mcp-sqlite/refs/heads/main/.readme/mcp-sqlite.jpg)
5
6#### Maintained by
7<a href="https://www.equilllabs.com">
8  <img src="https://raw.githubusercontent.com/jparkerweb/eQuill-Labs/refs/heads/main/src/static/images/logo-text-outline.png" alt="eQuill Labs" height="32">
9</a>
10
11## Features
12- Complete CRUD operations (Create, Read, Update, Delete)
13- Database exploration and introspection
14- Execute custom SQL queries
15
16## Setup
17
18Define the command in your IDE's MCP Server settings:
19
20e.g. `Cursor`:
21```json
22{
23    "mcpServers": {
24        "MCP SQLite Server": {
25            "command": "npx",
26            "args": [
27                "-y",
28                "mcp-sqlite",
29                "<path-to-your-sqlite-database.db>"
30            ]
31        }
32    }
33}
34```
35
36e.g. `VSCode`:
37```json
38{
39    "servers": {
40        "MCP SQLite Server": {
41            "type": "stdio",
42            "command": "npx",
43            "args": [
44                "-y",
45                "mcp-sqlite",
46                "<path-to-your-sqlite-database.db>"
47            ]
48        }
49    }
50}
51```
52
53![cursor-settings](https://raw.githubusercontent.com/jparkerweb/mcp-sqlite/refs/heads/main/.readme/cursor-mcp-settings.jpg)
54
55Your database path must be provided as an argument.
56
57## Available Tools
58
59### Database Information
60
61#### db_info
62
63Get detailed information about the connected database.
64
65Example:
66```json
67{
68  "method": "tools/call",
69  "params": {
70    "name": "db_info",
71    "arguments": {}
72  }
73}
74```
75
76#### list_tables
77
78List all tables in the database.
79
80Example:
81```json
82{
83  "method": "tools/call",
84  "params": {
85    "name": "list_tables",
86    "arguments": {}
87  }
88}
89```
90
91#### get_table_schema
92
93Get detailed information about a table's schema.
94
95Parameters:
96- `tableName` (string): Name of the table
97
98Example:
99```json
100{
101  "method": "tools/call",
102  "params": {
103    "name": "get_table_schema",
104    "arguments": {
105      "tableName": "users"
106    }
107  }
108}
109```
110
111### CRUD Operations
112
113#### create_record
114
115Insert a new record into a table.
116
117Parameters:
118- `table` (string): Name of the table
119- `data` (object): Record data as key-value pairs
120
121Example:
122```json
123{
124  "method": "tools/call",
125  "params": {
126    "name": "create_record",
127    "arguments": {
128      "table": "users",
129      "data": {
130        "name": "John Doe",
131        "email": "john@example.com",
132        "age": 30
133      }
134    }
135  }
136}
137```
138
139#### read_records
140
141Query records from a table with optional filtering.
142
143Parameters:
144- `table` (string): Name of the table
145- `conditions` (object, optional): Filter conditions as key-value pairs
146- `limit` (number, optional): Maximum number of records to return
147- `offset` (number, optional): Number of records to skip
148
149Example:
150```json
151{
152  "method": "tools/call",
153  "params": {
154    "name": "read_records",
155    "arguments": {
156      "table": "users",
157      "conditions": {
158        "age": 30
159      },
160      "limit": 10,
161      "offset": 0
162    }
163  }
164}
165```
166
167#### update_records
168
169Update records in a table that match specified conditions.
170
171Parameters:
172- `table` (string): Name of the table
173- `data` (object): New values as key-value pairs
174- `conditions` (object): Filter conditions as key-value pairs
175
176Example:
177```json
178{
179  "method": "tools/call",
180  "params": {
181    "name": "update_records",
182    "arguments": {
183      "table": "users",
184      "data": {
185        "email": "john.updated@example.com"
186      },
187      "conditions": {
188        "id": 1
189      }
190    }
191  }
192}
193```
194
195#### delete_records
196
197Delete records from a table that match specified conditions.
198
199Parameters:
200- `table` (string): Name of the table
201- `conditions` (object): Filter conditions as key-value pairs
202
203Example:
204```json
205{
206  "method": "tools/call",
207  "params": {
208    "name": "delete_records",
209    "arguments": {
210      "table": "users",
211      "conditions": {
212        "id": 1
213      }
214    }
215  }
216}
217```
218
219### Custom Queries
220
221#### query
222
223Execute a custom SQL query against the connected SQLite database.
224
225Parameters:
226- `sql` (string): The SQL query to execute
227- `values` (array, optional): Array of parameter values to use in the query
228
229Example:
230```json
231{
232  "method": "tools/call",
233  "params": {
234    "name": "query",
235    "arguments": {
236      "sql": "SELECT * FROM users WHERE id = ?",
237      "values": [1]
238    }
239  }
240}
241```
242
243## Built with
244
245- [Model Context Protocol SDK](https://github.com/modelcontextprotocol/typescript-sdk)
246- [sqlite3](https://github.com/TryGhost/node-sqlite3)
247
248---
249
250## Appreciation
251If you enjoy this library please consider sending me a tip to support my work 😀
252### [🍵 tip me here](https://ko-fi.com/jparkerweb)
253