chore: add npm package

Author: tianzhou

.github/workflows/npm-publish.yml

@@ -0,0 +1,58 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main  # Run when a push is made to the main branch
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org/'
+          scope: '@bytebase'
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: latest
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Update package.json for npm publishing
+        run: |
+          # Get the current version from package.json
+          CURRENT_VERSION=$(jq -r '.version' package.json)
+          
+          # Generate a version with date and commit hash suffix
+          COMMIT_HASH=$(git rev-parse --short HEAD)
+          DATE_VERSION=$(date +'%Y%m%d')
+          VERSION="${CURRENT_VERSION}-${DATE_VERSION}.${COMMIT_HASH}"
+          
+          # Update package.json to use @bytebase scope and set version
+          jq --arg version "$VERSION" '.name = "@bytebase/dbhub" | .version = $version' package.json > package.json.tmp
+          mv package.json.tmp package.json
+          
+          # Set files to include in the package
+          jq '.files = ["dist/**/*", "LICENSE", "README.md"]' package.json > package.json.tmp
+          mv package.json.tmp package.json
+          
+          # Add bin entry for CLI usage
+          jq '.bin = {"dbhub": "dist/index.js"}' package.json > package.json.tmp 
+          mv package.json.tmp package.json
+
+      - name: Publish to npm
+        run: pnpm publish --no-git-checks --access public --tag dev
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -33,7 +33,7 @@ DBHub is a universal database gateway implementing the Model Context Protocol (M
 - Run read-only SQL queries against the database
 - Safety checks to prevent dangerous queries
 
-## Usage
+## Installation
 
 ### Docker
 
@@ -47,9 +47,27 @@ docker run --rm --init \
    --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
 ```
 
+### NPM
+
+```bash
+# Install latest stable version globally
+npm install -g @bytebase/dbhub
+
+# Or install development version
+npm install -g @bytebase/dbhub@dev
+
+# Run from anywhere
+dbhub --dsn="postgres://user:password@localhost:5432/dbname"
+
+# Run via npx
+npx @bytebase/dbhub --dsn="postgres://user:password@localhost:5432/dbname"
+```
+
+## Usage
+
 ### Configure your database connection
 
-DBHub requires a Database Source Name (DSN) to connect to your database. You can provide this in several ways:
+Database Source Name (DSN) is required to connect to your database. You can provide this in several ways:
 
 - **Command line argument** (highest priority):
 
@@ -87,7 +105,7 @@ DBHub requires a Database Source Name (DSN) to connect to your database. You can
 ### Command line options
 
 | Option    | Description                                                     | Default                             |
-| --------- | --------------------------------------------------------------- | ----------------------------------- |
+| :-------- | :-------------------------------------------------------------- | :---------------------------------- |
 | dsn       | Database connection string                                      | Required if not set via environment |
 | transport | Transport mode: `stdio` or `sse`                                | `stdio`                             |
 | port      | HTTP server port (only applicable when using `--transport=sse`) | `8080`                              |

package.json

@@ -4,6 +4,14 @@
   "description": "Universal Database MCP Server",
   "main": "dist/index.js",
   "type": "module",
+  "bin": {
+    "dbhub": "dist/index.js"
+  },
+  "files": [
+    "dist/**/*",
+    "LICENSE",
+    "README.md"
+  ],
   "scripts": {
     "build": "tsc",
     "start": "node dist/index.js",

src/index.ts

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 // Import connector modules to register them
 import './connectors/postgres/index.js';  // Register PostgreSQL connector
 // import './connectors/sqlite/index.js';  // Uncomment to enable SQLite