Skip to content

Deployment: Dockerfile and Smithery config #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
# Use a base Python image
FROM python:3.9-slim

# Set the working directory
WORKDIR /app

# Copy the current directory contents into the container at /app
ADD . /app

# Install the required Python packages
RUN pip install --no-cache-dir -r requirements.txt

# Set environment variable for the database path
ENV SQLITE_DB_PATH="/path/to/your/database.db"

# Expose the port the app runs on
EXPOSE 8000

# Run the server
CMD ["uvicorn", "sqlite_explorer:app", "--host", "0.0.0.0", "--port", "8000"]
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# SQLite Explorer MCP Server

[![smithery badge](https://smithery.ai/badge/@hannesrudolph/sqlite-explorer-fastmcp-mcp-server)](https://smithery.ai/server/@hannesrudolph/sqlite-explorer-fastmcp-mcp-server)

An MCP server that provides safe, read-only access to SQLite databases through Model Context Protocol (MCP). This server is built with the FastMCP framework, which enables LLMs to explore and query SQLite databases with built-in safety features and query validation.

## 📋 System Requirements
Expand Down Expand Up @@ -69,6 +71,14 @@ You can install this MCP server in either Claude Desktop or the Cline VSCode plu

### Option 1: Install for Claude Desktop

#### Installing via Smithery

To install SQLite Explorer for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@hannesrudolph/sqlite-explorer-fastmcp-mcp-server):

```bash
npx -y @smithery/cli install @hannesrudolph/sqlite-explorer-fastmcp-mcp-server --client claude
```

Install using FastMCP:

```bash
Expand Down
17 changes: 17 additions & 0 deletions smithery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml

startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
required:
- sqliteDbPath
properties:
sqliteDbPath:
type: string
description: The full path to the SQLite database file.
commandFunction:
# A function that produces the CLI command to start the MCP on stdio.
|-
config => ({ command: 'uvicorn', args: ['sqlite_explorer:app', '--host', '0.0.0.0', '--port', '8000'], env: { SQLITE_DB_PATH: config.sqliteDbPath } })