{"_id":"@executeautomation/database-server","_rev":"4-49ca0c30501da2b1df1f215c92d4614b","name":"@executeautomation/database-server","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@executeautomation/database-server","version":"1.0.0","author":{"url":"https://executeautomation.com","name":"ExecuteAutomation"},"license":"MIT","_id":"@executeautomation/database-server@1.0.0","maintainers":[{"name":"executeautomation","email":"karthik@techgeek.co.in"}],"homepage":"https://executeautomation.com","bugs":{"url":"https://github.com/executeautomation/database-server/issues"},"bin":{"ea-database-server":"dist/src/index.js"},"dist":{"shasum":"44b42dde5c159656e240bd86b104bc952f16fb3b","tarball":"https://registry.npmjs.org/@executeautomation/database-server/-/database-server-1.0.0.tgz","fileCount":14,"integrity":"sha512-RXBG8jzjGGTp7uKaWmnkHvWNdaKa5tWnFwnVWwjoch0jJYoI3XrTAvOQ7FW7dgCCwz7ODESvMdliknZoisAg0g==","signatures":[{"sig":"MEQCIBzS+WFIX+LSaYIBGHPjSBq7Snyvp1WWhufBn9eRlUnPAiAShmRFZaij3rEAhXeonWeOflsgiCJUnW9LnYdI2JmWAw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":43975},"type":"module","gitHead":"4f953f16711b6d1140a9abaad7ebaeb798f556b0","scripts":{"dev":"tsc && node dist/src/index.js","build":"tsc && shx chmod +x dist/src/index.js","clean":"rimraf dist","start":"node dist/src/index.js","watch":"tsc --watch","example":"node examples/example.js","prepare":"npm run build"},"_npmUser":{"name":"executeautomation","email":"karthik@techgeek.co.in"},"_npmVersion":"10.7.0","description":"MCP server for interacting with SQLite and SQL Server databases by ExecuteAutomation","directories":{},"_nodeVersion":"20.14.0","dependencies":{"mssql":"11.0.1","sqlite3":"5.1.7","@modelcontextprotocol/sdk":"1.9.0"},"_hasShrinkwrap":false,"devDependencies":{"shx":"0.4.0","rimraf":"^5.0.5","typescript":"5.8.3","@types/mssql":"^9.1.5","@types/sqlite3":"5.1.0"},"_npmOperationalInternal":{"tmp":"tmp/database-server_1.0.0_1744602842266_0.17286925107475004","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@executeautomation/database-server","version":"1.0.1","author":{"url":"https://executeautomation.com","name":"ExecuteAutomation, Ltd"},"license":"MIT","_id":"@executeautomation/database-server@1.0.1","maintainers":[{"name":"executeautomation","email":"karthik@techgeek.co.in"}],"homepage":"https://github.com/executeautomation/mcp-database-server","bugs":{"url":"https://github.com/executeautomation/database-server/issues"},"bin":{"ea-database-server":"dist/src/index.js"},"dist":{"shasum":"cc6ea713a39c58b4b1fd0f45707107fcf0511619","tarball":"https://registry.npmjs.org/@executeautomation/database-server/-/database-server-1.0.1.tgz","fileCount":14,"integrity":"sha512-vfoB54em3OWhX6F8jIqjDzXlgGqVFjERaHShLoqdzGedrSD6hY0Kfk4+BKdDSkATPFU68YpPtB4IR28j9wG/9g==","signatures":[{"sig":"MEUCIQCkSSBXmcCK4GudA30zAS3dvXuAspnr4q7C9x8REWfZUQIgFg9mRCmGGQeAFNWbu4kKtAN5aLmdt5i7nntoJnqRhU8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":44007},"type":"module","gitHead":"e0ad4ff9fa9b5208a2bd48b2b1ba5202be3f6c1a","scripts":{"dev":"tsc && node dist/src/index.js","build":"tsc && shx chmod +x dist/src/index.js","clean":"rimraf dist","start":"node dist/src/index.js","watch":"tsc --watch","example":"node examples/example.js","prepare":"npm run build"},"_npmUser":{"name":"executeautomation","email":"karthik@techgeek.co.in"},"_npmVersion":"10.7.0","description":"MCP server for interacting with SQLite and SQL Server databases by ExecuteAutomation","directories":{},"_nodeVersion":"20.14.0","dependencies":{"mssql":"11.0.1","sqlite3":"5.1.7","@modelcontextprotocol/sdk":"1.9.0"},"_hasShrinkwrap":false,"devDependencies":{"shx":"0.4.0","rimraf":"^5.0.5","typescript":"5.8.3","@types/mssql":"^9.1.5","@types/sqlite3":"5.1.0"},"_npmOperationalInternal":{"tmp":"tmp/database-server_1.0.1_1744603050414_0.39876663775560295","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@executeautomation/database-server","version":"1.0.2","author":{"url":"https://executeautomation.com","name":"ExecuteAutomation, Ltd"},"license":"MIT","_id":"@executeautomation/database-server@1.0.2","maintainers":[{"name":"executeautomation","email":"karthik@techgeek.co.in"}],"homepage":"https://github.com/executeautomation/mcp-database-server","bugs":{"url":"https://github.com/executeautomation/database-server/issues"},"bin":{"ea-database-server":"dist/src/index.js"},"dist":{"shasum":"99df64c8342f21b2e789f864d8476674c2ccdf6a","tarball":"https://registry.npmjs.org/@executeautomation/database-server/-/database-server-1.0.2.tgz","fileCount":15,"integrity":"sha512-w6Rzu+YfqydeAg/xdLG+uDvjs1GGjkEO/mzz2Sxq8WmvrXk9sWVyymjT28GvWi8xEvcMLqJap9qQE+YiimgZMQ==","signatures":[{"sig":"MEUCIQCOrctZM5NiWGEdSUoTLKI6qH2VNYTm55Ao2ISlbmp7YQIgaXkeKL7ySy/OQtSKsp0escRoS1KDTpQqf8rqH0dyjyg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":53326},"type":"module","gitHead":"8d53747f7866c3f3169fcf8131990e703ff81d71","scripts":{"dev":"tsc && node dist/src/index.js","build":"tsc && shx chmod +x dist/src/index.js","clean":"rimraf dist","start":"node dist/src/index.js","watch":"tsc --watch","example":"node examples/example.js","prepare":"npm run build"},"_npmUser":{"name":"executeautomation","email":"karthik@techgeek.co.in"},"_npmVersion":"10.7.0","description":"MCP server for interacting with SQLite and SQL Server databases by ExecuteAutomation","directories":{},"_nodeVersion":"20.14.0","dependencies":{"pg":"^8.11.3","mssql":"11.0.1","sqlite3":"5.1.7","@modelcontextprotocol/sdk":"1.9.0"},"_hasShrinkwrap":false,"devDependencies":{"shx":"0.4.0","rimraf":"^5.0.5","@types/pg":"^8.11.13","typescript":"5.8.3","@types/mssql":"^9.1.5","@types/sqlite3":"5.1.0"},"_npmOperationalInternal":{"tmp":"tmp/database-server_1.0.2_1745307563177_0.31164582276502517","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@executeautomation/database-server","version":"1.1.0","description":"MCP server for interacting with SQLite and SQL Server databases by ExecuteAutomation","license":"MIT","author":{"name":"ExecuteAutomation, Ltd","url":"https://executeautomation.com"},"homepage":"https://github.com/executeautomation/mcp-database-server","bugs":{"url":"https://github.com/executeautomation/database-server/issues"},"type":"module","bin":{"ea-database-server":"dist/src/index.js"},"scripts":{"build":"tsc && shx chmod +x dist/src/index.js","prepare":"npm run build","watch":"tsc --watch","start":"node dist/src/index.js","dev":"tsc && node dist/src/index.js","example":"node examples/example.js","clean":"rimraf dist"},"dependencies":{"@modelcontextprotocol/sdk":"1.9.0","mssql":"11.0.1","mysql2":"^3.14.1","pg":"^8.11.3","sqlite3":"5.1.7"},"devDependencies":{"@types/mssql":"^9.1.5","@types/pg":"^8.11.13","@types/sqlite3":"5.1.0","rimraf":"^5.0.5","shx":"0.4.0","typescript":"5.8.3"},"_id":"@executeautomation/database-server@1.1.0","gitHead":"2d29108b3fe18f25ed7a04ac7df04d45897b7be6","_nodeVersion":"20.14.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-5PJzcX5UYiTBp5/DGwuNzvKzcQpIZp9kSIouBR2GY6HzA2i1M+zd6A1kkiXj588Y7X186jyfm0HpTAheNBapqw==","shasum":"9f25a89fdfbd689275abdf7cd575ac386f237dd9","tarball":"https://registry.npmjs.org/@executeautomation/database-server/-/database-server-1.1.0.tgz","fileCount":16,"unpackedSize":60897,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCSlsczcSqTrAgp8haGUkK7FofsAIx+prPuJdFUSqTFBgIgUYjD5ntr9Riyykq46wU/BXlGHnkaF9IyDgOhtagJIVc="}]},"_npmUser":{"name":"executeautomation","email":"karthik@techgeek.co.in"},"directories":{},"maintainers":[{"name":"executeautomation","email":"karthik@techgeek.co.in"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/database-server_1.1.0_1748637536162_0.1985900599006687"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-14T03:54:02.180Z","modified":"2025-05-30T20:38:56.593Z","1.0.0":"2025-04-14T03:54:02.457Z","1.0.1":"2025-04-14T03:57:30.588Z","1.0.2":"2025-04-22T07:39:23.341Z","1.1.0":"2025-05-30T20:38:56.403Z"},"bugs":{"url":"https://github.com/executeautomation/database-server/issues"},"author":{"name":"ExecuteAutomation, Ltd","url":"https://executeautomation.com"},"license":"MIT","homepage":"https://github.com/executeautomation/mcp-database-server","description":"MCP server for interacting with SQLite and SQL Server databases by ExecuteAutomation","maintainers":[{"name":"executeautomation","email":"karthik@techgeek.co.in"}],"readme":"[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/executeautomation-mcp-database-server-badge.png)](https://mseep.ai/app/executeautomation-mcp-database-server)\n\n# MCP Database Server\n\nThis MCP (Model Context Protocol) server provides database access capabilities to Claude, supporting SQLite, SQL Server, PostgreSQL, and MySQL 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 <server-name> --database <database-name> [--user <username> --password <password>]\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 <host-name> --database <database-name> [--user <username> --password <password>]\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### MySQL Database\n\nTo use with a MySQL database:\n\n```\nnode dist/src/index.js --mysql --host <host-name> --database <database-name> --port <port> [--user <username> --password <password>]\n```\n\nRequired parameters:\n- `--host`: MySQL host name or IP address\n- `--database`: Name of the database\n- `--port`: Port number (default: 3306)\n\nOptional parameters:\n- `--user`: Username for MySQL authentication\n- `--password`: Password for MySQL authentication\n- `--ssl`: Enable SSL connection (true/false or object)\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    \"mysql\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"-y\",\n        \"@executeautomation/database-server\",\n        \"--mysql\",\n        \"--host\", \"your-host-name\",\n        \"--database\", \"your-database-name\",\n        \"--port\", \"3306\",\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    \"mysql\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"/absolute/path/to/mcp-database-server/dist/src/index.js\",\n        \"--mysql\",\n        \"--host\", \"your-host-name\",\n        \"--database\", \"your-database-name\",\n        \"--port\", \"3306\",\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<br>`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<br>`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","readmeFilename":"readme.md"}