cuongtl1992/mcp-dbs

A Model Context Protocol (MCP) implementation for connecting to and working with various database systems.
## Supported Databases
SQLite
PostgreSQL
Microsoft SQL Server
MongoDB
## Installation
bash
npm install -g mcp-dbs
## Usage
The MCP Database Server can be used in two modes:
### SSE Mode (Default)
By default, the server runs in SSE (Server-Sent Events) mode on port 3001:
bash
npx mcp-dbs
This will start an HTTP server with an SSE endpoint at http://localhost:3001/mcp.
#### Custom Port
You can specify a custom port using the --port option:
bash
npx mcp-dbs --port 8080
### STDIO Mode
For tools that communicate over standard input/output, you can use the --stdio option:
bash
npx mcp-dbs --stdio
## Claude Desktop Integration
You can integrate mcp-dbs with Claude Desktop by adding it to your Claude configuration file.
### Configuration Steps
1. Open or create your Claude Desktop configuration file
2. Add the mcp-dbs configuration to the mcpServers section:
json
"mcpServers": {
"mcp-dbs": {
"command": "node",
"args": [
"/path/to/your/mcp-dbs/dist/cli.js",
"--stdio"
],
"env": {
"MCPMONGODBURI": "mongodb://localhost:27017",
"MCPMONGODBDATABASE": "your-database-name"
Replace the environment variables with your own database connection details.
### Notes
The command should be node
In args, provide the absolute path to the cli.js file in your mcp-dbs installation
Configure the appropriate environment variables for your database type (see the environment variables section below)
You can use environment variables for any of the supported databases (SQLite, PostgreSQL, SQL Server, or MongoDB)
### Using with Claude
Once configured, Claude will be able to access your database using the MCP tools described below. You can ask Claude to:
Connect to your database
Execute queries and get results
Explore your database schema
Work with tables and data
## Tools
connect-database: Connect to a database
disconnect-database: Disconnect from a database
execute-query: Execute a query and return results
execute-update: Execute a query without returning results
## Resources
database-schema: Get the full database schema
table-schema: Get the schema for a specific table
tables-list: Get a list of all tables
## Using environment variables for configuration
You can configure your database connections using environment variables:
#### SQLite
bash
# Set these environment variables before connecting
export MCPSQLITEFILENAME="path/to/database.db"
export MCPSQLITECREATEIFNOTEXISTS="true"
#### PostgreSQL
bash
# Set these environment variables before connecting
export MCPPOSTGRESHOST="your-postgres-host"
export MCPPOSTGRESPORT="5432"
export MCPPOSTGRESDATABASE="your-database-name"
export MCPPOSTGRESUSER="your-username"
export MCPPOSTGRESPASSWORD="your-password"
export MCPPOSTGRESSSL="false"
#### SQL Server
bash
# Set these environment variables before connecting
export MCPMSSQLSERVER="your-server-address"
export MCPMSSQLPORT="1433"
export MCPMSSQLDATABASE="your-database-name"
export MCPMSSQLUSER="your-username"
export MCPMSSQLPASSWORD="your-password"
export MCPMSSQLENCRYPT="true"
export MCPMSSQLTRUSTSERVERCERTIFICATE="true"
#### MongoDB
bash
# Set these environment variables before connecting