Skip to main content

MCP server for SQLite files. Supports Datasette-compatible metadata!

Project description

mcp-sqlite

Provide useful data to AI agents without giving them access to external systems. Compatible with Datasette for human users!

Features

  • AI agents can get the structure of all tables and columns in the SQLite database in one command - sqlite_get_catalog.
    • The catalog can be enriched with descriptions for the tables and columns using a simple YAML or JSON metadata file.
  • The same metadata file can contain canned queries to the AI to use. Each canned query will be turned into a separate MCP tool sqlite_execute_main_{tool name}.
  • AI agents can execute arbitrary SQL queries with sqlite_execute.

Quickstart using Visual Studio Code

  1. Install uv.

  2. Install Visual Studio Code if you don't already have it. Turn on GitHub Copilot.

  3. Open this repo in VS Code. Open a GitHub Copilot agent mode chat. Check the available tools - you should see MCP Server: sqlite_sample with three available tools.

  4. You should be able to ask Copilot in agent mode a question like "Get Titanic survivors of age 28" and get a response.

  5. Use the sample MCP configuration file mcp.json and the sample metadata file titanic.yml as a starting point for your own configuration.

Interactive exploration with MCP Inspector and Datasette

The same database and metadata files can be used to explore the data interactively with MCP Inspector and Datasette.

MCP Inspector Datasette

MCP Inspector

Use the MCP Inspector dashboard to interact with the SQLite database the same way that an AI agent would:

  1. Install npm.
  2. Run:
    npx @modelcontextprotocol/inspector uvx mcp-sqlite sample/titanic.db --metadata sample/titanic.yml
    

Datasette

Since mcp-sqlite metadata is compatible with the Datasette metadata file, you can also explore your data with Datasette:

uvx datasette serve sample/titanic.db --metadata sample/titanic.yml

Compatibility with Datasette allows both AI agents and humans to easily explore the same local data!

MCP Tools provided by mcp-sqlite

  • sqlite_get_catalog(): Tool the agent can call to get the complete catalog of the databases, tables, and columns in the data, combined with metadata from the metadata file. In an earlier iteration of mcp-sqlite, this was a resource instead of a tool, but resources are not as widely supported, so it got turned into a tool. If you have a usecase for the catalog as a resource, open an issue and we'll bring it back!
  • sqlite_execute(sql): Tool the agent can call to execute arbitrary SQL. The table results are returned as HTML. For more information about why HTML is the best format for LLMs to process, see Siu et al.
  • {canned query name}({canned query args}): A tool is created for each canned query in the metadata, allowing the agent to run predefined queries without writing any SQL.

Usage

Command-line options

usage: mcp-sqlite [-h] [-m METADATA] [-p PREFIX] [-v] sqlite_file

CLI command to start an MCP server for interacting with SQLite data.

positional arguments:
  sqlite_file           Path to SQLite file to serve the MCP server for.

options:
  -h, --help            show this help message and exit
  -m, --metadata METADATA
                        Path to Datasette-compatible metadata YAML or JSON file.
  -p, --prefix PREFIX   Prefix for MCP tools. Defaults to no prefix.
  -v, --verbose         Be verbose. Include once for INFO output, twice for DEBUG output.

Metadata

Hidden tables

Hiding a table with hidden: true will hide it from the catalog returned by the MCP tool sqlite_get_catalog(). However, note that the table will still be accessible by the AI agent! Never rely on hiding a table from the catalog as a security feature.

Canned queries

Canned queries are each turned into a separate callable MCP tool by mcp-sqlite.

For example, a query named my_canned_query will become a tool my_canned_query.

The canned queries functionality is still in active development with more features planned for development soon:

Roadmap

Datasette query feature Supported in mcp-sqlite?
Displayed in catalog
Executable
Titles
Descriptions
Parameters
Explicit parameters ❌ (planned)
Hide SQL
Write restrictions on canned queries
Pagination ❌ (planned)
Cross-database queries ❌ (planned)
Fragments ❌ (not planned)
Magic parameters ❌ (not planned)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_panasenco_mcp_sqlite-0.3.2.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_panasenco_mcp_sqlite-0.3.2-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_panasenco_mcp_sqlite-0.3.2.tar.gz.

File metadata

  • Download URL: iflow_mcp_panasenco_mcp_sqlite-0.3.2.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_panasenco_mcp_sqlite-0.3.2.tar.gz
Algorithm Hash digest
SHA256 9b82738663fc4746eec51f5c3836261e1338bc8fa11124d1f325baab409990a7
MD5 6765b2fe273bce99f75613eaf7305355
BLAKE2b-256 d5bdccda0d45fd7fe7621bffb5ac3d49a993bf10f6968b41c2e02bb99ca8f77c

See more details on using hashes here.

File details

Details for the file iflow_mcp_panasenco_mcp_sqlite-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_panasenco_mcp_sqlite-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_panasenco_mcp_sqlite-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 afd1e22b9095de39777791d15c06bd0f72fbdaad1f83f3609465aef28478126c
MD5 bb8e058357ab02038b950741b97f0456
BLAKE2b-256 eff8deb575076c49d613d77594e524f245569eb64e658ea92bd859ec4a7bf0f2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page