MCP-Database-Server

What is MCP Database Server?

MCP Database Server is a Model Context Protocol (MCP) server designed to provide database access capabilities to AI models like Claude. It supports connections to various relational databases, including SQLite, SQL Server, PostgreSQL, and MySQL.

How to use MCP Database Server?

There are two primary ways to use the MCP Database Server:

1. Direct Usage (NPM Package): Install the server globally via npm: npm install -g @executeautomation/database-server. This allows direct use without local building.
2. Local Development: Clone the repository, install dependencies (npm install), and build the project (npm run build). Then, run the server using node dist/src/index.js with specific arguments for your chosen database type (SQLite, SQL Server, PostgreSQL, MySQL).

To integrate with Claude Desktop, you need to configure the mcpServers section in your Claude Desktop configuration file (e.g., ~/Library/Application Support/Claude/claude_desktop_config.json on macOS) with the appropriate command and arguments for direct usage or local development.

Key Features of MCP Database Server

• Multi-Database Support: Connects to SQLite, SQL Server, PostgreSQL, and MySQL databases.
• MCP Integration: Designed to work seamlessly with MCP-compatible AI models like Claude.
• Comprehensive Database Tools: Provides a range of tools for AI models to interact with databases, including:
  • read_query: Execute SELECT queries.
  • write_query: Execute INSERT, UPDATE, or DELETE queries.
  • create_table: Create new tables.
  • alter_table: Modify existing table schemas.
  • drop_table: Remove tables.
  • list_tables: List all tables.
  • describe_table: View table schema information.
  • export_query: Export query results as CSV/JSON.
  • append_insight: Add business insights.
  • list_insights: List all business insights.
• Flexible Usage Options: Supports both global NPM package installation and local development setups.

Use Cases of MCP Database Server

• AI-Powered Data Analysis: Enable AI models to query and analyze data directly from various databases.
• Automated Data Management: Allow AI to perform data manipulation tasks (insert, update, delete) based on defined logic.
• Database Schema Management: Facilitate AI-driven creation and modification of database tables.
• Business Intelligence: Empower AI to extract and summarize business insights from database content.
• Integration with Claude Desktop: Seamlessly integrate database interaction capabilities into Claude Desktop for enhanced AI functionalities.

FAQ about MCP Database Server

Q: What databases does MCP Database Server support? A: It supports SQLite, SQL Server, PostgreSQL, and MySQL.

Q: How do I install MCP Database Server? A: You can install it globally via npm (npm install -g @executeautomation/database-server) or clone the repository and build it locally.

Q: How do I configure Claude Desktop to use MCP Database Server? A: You need to modify the mcpServers section in your Claude Desktop configuration file with the appropriate command and arguments for your chosen database and usage method.

Q: What kind of database operations can Claude perform using this server? A: Claude can perform read (SELECT), write (INSERT, UPDATE, DELETE), table creation, alteration, dropping, listing, describing, and exporting queries, as well as managing business insights.

Q: What are the requirements for running MCP Database Server? A: Node.js 18+ is required. Specific database versions are also needed for SQL Server (2012+) and PostgreSQL (9.5+).

MCP Database Server

This MCP (Model Context Protocol) server provides database access capabilities to Claude, supporting SQLite, SQL Server, PostgreSQL, and MySQL databases.

Installation

1. Clone the repository:

git clone https://github.com/executeautomation/mcp-database-server.git
cd database-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

Usage Options

There are two ways to use this MCP server with Claude:

1. Direct usage: Install the package globally and use it directly
2. Local development: Run from your local development environment

Direct Usage with NPM Package

The easiest way to use this MCP server is by installing it globally:

npm install -g @executeautomation/database-server

This allows you to use the server directly without building it locally.

Local Development Setup

If you want to modify the code or run from your local environment:

1. Clone and build the repository as shown in the Installation section
2. Run the server using the commands in the Usage section below

Usage

SQLite Database

To use with an SQLite database:

node dist/src/index.js /path/to/your/database.db

SQL Server Database

To use with a SQL Server database:

node dist/src/index.js --sqlserver --server <server-name> --database <database-name> [--user <username> --password <password>]

Required parameters:

• --server: SQL Server host name or IP address
• --database: Name of the database

Optional parameters:

• --user: Username for SQL Server authentication (if not provided, Windows Authentication will be used)
• --password: Password for SQL Server authentication
• --port: Port number (default: 1433)

PostgreSQL Database

To use with a PostgreSQL database:

node dist/src/index.js --postgresql --host <host-name> --database <database-name> [--user <username> --password <password>]

Required parameters:

• --host: PostgreSQL host name or IP address
• --database: Name of the database

Optional parameters:

• --user: Username for PostgreSQL authentication
• --password: Password for PostgreSQL authentication
• --port: Port number (default: 5432)
• --ssl: Enable SSL connection (true/false)
• --connection-timeout: Connection timeout in milliseconds (default: 30000)

MySQL Database

To use with a MySQL database:

node dist/src/index.js --mysql --host <host-name> --database <database-name> --port <port> [--user <username> --password <password>]

Required parameters:

• --host: MySQL host name or IP address
• --database: Name of the database
• --port: Port number (default: 3306)

Optional parameters:

• --user: Username for MySQL authentication
• --password: Password for MySQL authentication
• --ssl: Enable SSL connection (true/false or object)
• --connection-timeout: Connection timeout in milliseconds (default: 30000)

Configuring Claude Desktop

Direct Usage Configuration

If you installed the package globally, configure Claude Desktop with:

{
  "mcpServers": {
    "sqlite": {
      "command": "npx",
      "args": [
        "-y",
        "@executeautomation/database-server",
        "/path/to/your/database.db"
      ]
    },
    "sqlserver": {
      "command": "npx",
      "args": [
        "-y",
        "@executeautomation/database-server",
        "--sqlserver",
        "--server", "your-server-name",
        "--database", "your-database-name",
        "--user", "your-username",
        "--password", "your-password"
      ]
    },
    "postgresql": {
      "command": "npx",
      "args": [
        "-y",
        "@executeautomation/database-server",
        "--postgresql",
        "--host", "your-host-name",
        "--database", "your-database-name",
        "--user", "your-username",
        "--password", "your-password"
      ]
    },
    "mysql": {
      "command": "npx",
      "args": [
        "-y",
        "@executeautomation/database-server",
        "--mysql",
        "--host", "your-host-name",
        "--database", "your-database-name",
        "--port", "3306",
        "--user", "your-username",
        "--password", "your-password"
      ]
    }
  }
}

Local Development Configuration

For local development, configure Claude Desktop to use your locally built version:

{
  "mcpServers": {
    "sqlite": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-database-server/dist/src/index.js", 
        "/path/to/your/database.db"
      ]
    },
    "sqlserver": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-database-server/dist/src/index.js",
        "--sqlserver",
        "--server", "your-server-name",
        "--database", "your-database-name",
        "--user", "your-username",
        "--password", "your-password"
      ]
    },
    "postgresql": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-database-server/dist/src/index.js",
        "--postgresql",
        "--host", "your-host-name",
        "--database", "your-database-name",
        "--user", "your-username",
        "--password", "your-password"
      ]
    },
    "mysql": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-database-server/dist/src/index.js",
        "--mysql",
        "--host", "your-host-name",
        "--database", "your-database-name",
        "--port", "3306",
        "--user", "your-username",
        "--password", "your-password"
      ]
    }
  }
}

The Claude Desktop configuration file is typically located at:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

Available Database Tools

The MCP Database Server provides the following tools that Claude can use:

Tool	Description	Required Parameters
read_query	Execute SELECT queries to read data	query: SQL SELECT statement
write_query	Execute INSERT, UPDATE, or DELETE queries	query: SQL modification statement
create_table	Create new tables in the database	query: CREATE TABLE statement
alter_table	Modify existing table schema	query: ALTER TABLE statement
drop_table	Remove a table from the database	table_name: Name of tableconfirm: Safety flag (must be true)
list_tables	Get a list of all tables	None
describe_table	View schema information for a table	table_name: Name of table
export_query	Export query results as CSV/JSON	query: SQL SELECT statementformat: "csv" or "json"
append_insight	Add a business insight to memo	insight: Text of insight
list_insights	List all business insights	None

For practical examples of how to use these tools with Claude, see Usage Examples.

Additional Documentation

• SQL Server Setup Guide: Details on connecting to SQL Server databases
• PostgreSQL Setup Guide: Details on connecting to PostgreSQL databases
• Usage Examples: Example queries and commands to use with Claude

Development

To run the server in development mode:

npm run dev

To watch for changes during development:

npm run watch

Requirements

• Node.js 18+
• For SQL Server connectivity: SQL Server 2012 or later
• For PostgreSQL connectivity: PostgreSQL 9.5 or later

License

MIT