Skip to content

Latest commit

 

History

History
113 lines (86 loc) · 2.72 KB

README.md

File metadata and controls

113 lines (86 loc) · 2.72 KB

MCP SQLite Server

smithery badge

A Node.js implementation of the Model Context Protocol SQLite server, based on the official Python reference. This version provides an npx-based alternative for environments where Python's UVX runner is not available, such as LibreChat.

Use with Claude Desktop

Installing via Smithery

To install MCP SQLite Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install mcp-server-sqlite-npx --client claude

Installing Manually

Add the following to claude_desktop_config.json:

{
  "mcpServers": {
    "sqlite": {
      "command": "/absolute/path/to/npx",
      "args": [
        "-y",
        "mcp-server-sqlite-npx",
        "/absolute/path/to/database.db"
      ],
      "env": {
        "PATH": "/absolute/path/to/executables",
        "NODE_PATH": "/absolute/path/to/node_modules"
      }
    }
  }
}

Here's a full example when using nvm:

{
  "mcpServers": {
    "sqlite": {
      "command": "/Users/johnny/.nvm/versions/node/v22.12.0/bin/npx",
      "args": [
        "-y",
        "mcp-server-sqlite-npx",
        "/Users/johnny/projects/database.db"
      ],
      "env": {
        "PATH": "/Users/johnny/.nvm/versions/node/v22.12.0/bin:/usr/local/bin:/usr/bin:/bin",
        "NODE_PATH": "/Users/johnny/.nvm/versions/node/v22.12.0/lib/node_modules"
      }
    }
  }
}

Development

  1. Install dependencies:
npm ci
  1. Build the TypeScript code:
npm run build

Testing with MCP Inspector

You can test the server using the MCP Inspector tool:

npx @modelcontextprotocol/inspector node dist/index.js /absolute/path/to/database.db

Connect and go to Tools to start using the server.

Testing with Claude Desktop

Add the following to claude_desktop_config.json:

{
  "mcpServers": {
    "sqlite": {
      "command": "/absolute/path/to/node",
      "args": [
        "/absolute/path/to/dist/index.js",
        "/absolute/path/to/database.db"
      ]
    }
  }
}

Examples:

  • /absolute/path/to/node: /Users/johnny/.nvm/versions/node/v20.18.1/bin/node
  • /absolute/path/to/index.js: /Users/johnny/projects/mcp-server-sqlite-npx/dist/index.js
  • /absolute/path/to/database.db: /Users/johnny/projects/database.db

Publish

  • Bump version in package.json
  • npm install
  • Commit with message: Release {version, e.g. 0.1.6}