Sqlite Explorer

🚀 SQLite Database Explorer MCP Server

A SQLite database server that provides secure read-only access via the Model Context Protocol (MCP). Built on the FastMCP framework, this server enables LLMs to explore and query SQLite databases, with built-in security features and query validation.

🚀 Quick Start

Clone the repository:

git clone https://github.com/hannesrudolph/sqlite-explorer-fastmcp-mcp-server.git
cd sqlite-explorer-fastmcp-mcp-server

✨ Features

• Secure Read-Only Access: Ensures the database can only be accessed in read-only mode.
• Query Validation and Sanitization: Prevents injection attacks and ensures input security.
• Result Limitation: Controls the amount of returned data to avoid data leakage risks.

📦 Installation

System Requirements

• Python 3.6+
• SQLite database file (path specified via environment variables)

Dependencies

Install all necessary dependencies:

# Use pip
pip install -r requirements.txt

Required Packages

• fastmcp: The framework for building MCP servers.

All dependencies are listed in requirements.txt for easy installation.

Installation Options

You can install this MCP server in Claude Desktop or the Cline VSCode plugin. Choose the option that suits your needs.

Option 1: Install for Claude Desktop

Install using FastMCP:

fastmcp install sqlite_explorer.py --name "SQLite Explorer" -e SQLITE_DB_PATH=/path/to/db

Replace /path/to/db with the path to your database file.

Option 2: Install for Cline VSCode Plugin

To use this server with the Cline VSCode plugin:

1. In VSCode, click the server icon (☰) in the left sidebar.
2. Click the "Edit MCP Settings" button (✎).
3. Add the following configuration to the settings file:

{
  "sqlite-explorer": {
    "command": "uv",
    "args": [
      "run",
      "--with",
      "fastmcp",
      "--with",
      "uvicorn",
      "fastmcp",
      "run",
      "/path/to/repo/sqlite_explorer.py"
    ],
    "env": {
      "SQLITE_DB_PATH": "/path/to/your/database.db"
    }
  }
}

Replace /path/to/repo and /path/to/your/database.db with your actual paths.

💻 Usage Examples

Basic Usage

The server provides the following tools for LLMs:

read_query

Execute a SELECT query on the database with built-in security validation. Features include:

• Query validation and sanitization
• Parameter binding support
• Row count limit enforcement
• Results formatted as a dictionary

list_tables

List all available tables and their names in the database.

describe_table

Get detailed schema information for a specific table, including:

• Column names and types
• NULL constraints
• Default values
• Primary key information

📚 Documentation

Safety Features

• Read-Only Access: Ensures the database can only be accessed in read-only mode.
• Query Validation and Sanitization: Prevents injection attacks and ensures input security.
• Result Limitation: Controls the amount of returned data to avoid data leakage risks.

Development Documentation

For detailed information on development and integration, refer to the FastMCP documentation and the GitHub repository.

Environment Variables

• SQLITE_DB_PATH: Specifies the path to the SQLite database file. For example, /path/to/your/database.db.

Make sure to set this environment variable before running the server to access the database file correctly.