{"id":27639470,"url":"https://github.com/executeautomation/mcp-database-server","last_synced_at":"2025-04-23T22:16:54.880Z","repository":{"id":287633600,"uuid":"965337009","full_name":"executeautomation/mcp-database-server","owner":"executeautomation","description":"MCP Database Server is a new MCP Server which helps connect with Sqlite, SqlServer and Posgresql Databases","archived":false,"fork":false,"pushed_at":"2025-04-22T07:19:52.000Z","size":10379,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T22:16:49.155Z","etag":null,"topics":["mcp-server","posgresql","sqlite","sqlserver"],"latest_commit_sha":null,"homepage":"https://executeautomation.github.io/mcp-database-server/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/executeautomation.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-12T23:47:53.000Z","updated_at":"2025-04-23T17:48:59.000Z","dependencies_parsed_at":"2025-04-13T00:25:11.393Z","dependency_job_id":"589d876f-e27f-49ea-96ff-c51b1f554c6f","html_url":"https://github.com/executeautomation/mcp-database-server","commit_stats":null,"previous_names":["executeautomation/mcp-database-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executeautomation%2Fmcp-database-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executeautomation%2Fmcp-database-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executeautomation%2Fmcp-database-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executeautomation%2Fmcp-database-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/executeautomation","download_url":"https://codeload.github.com/executeautomation/mcp-database-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250522296,"owners_count":21444512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mcp-server","posgresql","sqlite","sqlserver"],"created_at":"2025-04-23T22:16:54.357Z","updated_at":"2025-04-23T22:16:54.873Z","avatar_url":"https://github.com/executeautomation.png","language":"TypeScript","readme":"# MCP Database Server\n\nThis MCP (Model Context Protocol) server provides database access capabilities to Claude, supporting SQLite, SQL Server, and PostgreSQL databases.\n\n## Installation\n\n1. Clone the repository:\n```\ngit clone https://github.com/executeautomation/database-server.git\ncd database-server\n```\n\n2. Install dependencies:\n```\nnpm install\n```\n\n3. Build the project:\n```\nnpm run build\n```\n\n## Usage Options\n\nThere are two ways to use this MCP server with Claude:\n\n1. **Direct usage**: Install the package globally and use it directly\n2. **Local development**: Run from your local development environment\n\n### Direct Usage with NPM Package\n\nThe easiest way to use this MCP server is by installing it globally:\n\n```bash\nnpm install -g @executeautomation/database-server\n```\n\nThis allows you to use the server directly without building it locally.\n\n### Local Development Setup\n\nIf you want to modify the code or run from your local environment:\n\n1. Clone and build the repository as shown in the Installation section\n2. Run the server using the commands in the Usage section below\n\n## Usage\n\n### SQLite Database\n\nTo use with an SQLite database:\n\n```\nnode dist/src/index.js /path/to/your/database.db\n```\n\n### SQL Server Database\n\nTo use with a SQL Server database:\n\n```\nnode dist/src/index.js --sqlserver --server \u003cserver-name\u003e --database \u003cdatabase-name\u003e [--user \u003cusername\u003e --password \u003cpassword\u003e]\n```\n\nRequired parameters:\n- `--server`: SQL Server host name or IP address\n- `--database`: Name of the database\n\nOptional parameters:\n- `--user`: Username for SQL Server authentication (if not provided, Windows Authentication will be used)\n- `--password`: Password for SQL Server authentication\n- `--port`: Port number (default: 1433)\n\n### PostgreSQL Database\n\nTo use with a PostgreSQL database:\n\n```\nnode dist/src/index.js --postgresql --host \u003chost-name\u003e --database \u003cdatabase-name\u003e [--user \u003cusername\u003e --password \u003cpassword\u003e]\n```\n\nRequired parameters:\n- `--host`: PostgreSQL host name or IP address\n- `--database`: Name of the database\n\nOptional parameters:\n- `--user`: Username for PostgreSQL authentication\n- `--password`: Password for PostgreSQL authentication\n- `--port`: Port number (default: 5432)\n- `--ssl`: Enable SSL connection (true/false)\n- `--connection-timeout`: Connection timeout in milliseconds (default: 30000)\n\n## Configuring Claude Desktop\n\n### Direct Usage Configuration\n\nIf you installed the package globally, configure Claude Desktop with:\n\n```json\n{\n  \"mcpServers\": {\n    \"sqlite\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"-y\",\n        \"@executeautomation/database-server\",\n        \"/path/to/your/database.db\"\n      ]\n    },\n    \"sqlserver\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"-y\",\n        \"@executeautomation/database-server\",\n        \"--sqlserver\",\n        \"--server\", \"your-server-name\",\n        \"--database\", \"your-database-name\",\n        \"--user\", \"your-username\",\n        \"--password\", \"your-password\"\n      ]\n    },\n    \"postgresql\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"-y\",\n        \"@executeautomation/database-server\",\n        \"--postgresql\",\n        \"--host\", \"your-host-name\",\n        \"--database\", \"your-database-name\",\n        \"--user\", \"your-username\",\n        \"--password\", \"your-password\"\n      ]\n    }\n  }\n}\n```\n\n### Local Development Configuration\n\nFor local development, configure Claude Desktop to use your locally built version:\n\n```json\n{\n  \"mcpServers\": {\n    \"sqlite\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"/absolute/path/to/mcp-database-server/dist/src/index.js\", \n        \"/path/to/your/database.db\"\n      ]\n    },\n    \"sqlserver\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"/absolute/path/to/mcp-database-server/dist/src/index.js\",\n        \"--sqlserver\",\n        \"--server\", \"your-server-name\",\n        \"--database\", \"your-database-name\",\n        \"--user\", \"your-username\",\n        \"--password\", \"your-password\"\n      ]\n    },\n    \"postgresql\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"/absolute/path/to/mcp-database-server/dist/src/index.js\",\n        \"--postgresql\",\n        \"--host\", \"your-host-name\",\n        \"--database\", \"your-database-name\",\n        \"--user\", \"your-username\",\n        \"--password\", \"your-password\"\n      ]\n    }\n  }\n}\n```\n\nThe Claude Desktop configuration file is typically located at:\n- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`\n- Windows: `%APPDATA%\\Claude\\claude_desktop_config.json`\n- Linux: `~/.config/Claude/claude_desktop_config.json`\n\n## Available Database Tools\n\nThe MCP Database Server provides the following tools that Claude can use:\n\n| Tool | Description | Required Parameters |\n|------|-------------|---------------------|\n| `read_query` | Execute SELECT queries to read data | `query`: SQL SELECT statement |\n| `write_query` | Execute INSERT, UPDATE, or DELETE queries | `query`: SQL modification statement |\n| `create_table` | Create new tables in the database | `query`: CREATE TABLE statement |\n| `alter_table` | Modify existing table schema | `query`: ALTER TABLE statement |\n| `drop_table` | Remove a table from the database | `table_name`: Name of table\u003cbr\u003e`confirm`: Safety flag (must be true) |\n| `list_tables` | Get a list of all tables | None |\n| `describe_table` | View schema information for a table | `table_name`: Name of table |\n| `export_query` | Export query results as CSV/JSON | `query`: SQL SELECT statement\u003cbr\u003e`format`: \"csv\" or \"json\" |\n| `append_insight` | Add a business insight to memo | `insight`: Text of insight |\n| `list_insights` | List all business insights | None |\n\nFor practical examples of how to use these tools with Claude, see [Usage Examples](docs/usage-examples.md).\n\n## Additional Documentation\n\n- [SQL Server Setup Guide](docs/sql-server-setup.md): Details on connecting to SQL Server databases\n- [PostgreSQL Setup Guide](docs/postgresql-setup.md): Details on connecting to PostgreSQL databases\n- [Usage Examples](docs/usage-examples.md): Example queries and commands to use with Claude\n\n## Development\n\nTo run the server in development mode:\n\n```\nnpm run dev\n```\n\nTo watch for changes during development:\n\n```\nnpm run watch\n```\n\n## Requirements\n\n- Node.js 18+\n- For SQL Server connectivity: SQL Server 2012 or later\n- For PostgreSQL connectivity: PostgreSQL 9.5 or later\n\n## License\n\nMIT\n","funding_links":[],"categories":["Databases","Database \u0026 Messaging MCP Servers","📚 Projects (1974 total)","TypeScript","📦 Other"],"sub_categories":["Multi-Database Tools","MCP Servers","How to Submit"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecuteautomation%2Fmcp-database-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexecuteautomation%2Fmcp-database-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecuteautomation%2Fmcp-database-server/lists"}