@bytebase/dbhub 0.1.0 → 0.1.1

package/dist/server.js

@@ -1,140 +0,0 @@
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { SSEServerTransport } from "@modelcontextprotocol/sdk/server/sse.js";
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import express from 'express';
-import path from 'path';
-import { readFileSync } from 'fs';
-import { fileURLToPath } from 'url';
-import { ConnectorManager } from './connectors/manager.js';
-import { ConnectorRegistry } from './connectors/interface.js';
-import { resolveDSN, resolveTransport, resolvePort } from './config/env.js';
-import { getSqliteInMemorySetupSql } from './config/demo-loader.js';
-import { registerResources } from './resources/index.js';
-import { registerTools } from './tools/index.js';
-import { registerPrompts } from './prompts/index.js';
-// Create __dirname equivalent for ES modules
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-// Load package.json to get version
-const packageJsonPath = path.join(__dirname, '..', 'package.json');
-const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
-// Server info
-export const SERVER_NAME = "DBHub MCP Server";
-export const SERVER_VERSION = packageJson.version;
-/**
- * Generate ASCII art banner with version information
- */
-export function generateBanner(version, isDemo = false) {
-    const demoText = isDemo ? " [DEMO MODE]" : "";
-    return `
- _____  ____  _   _       _     
-|  __ \\|  _ \\| | | |     | |    
-| |  | | |_) | |_| |_   _| |__  
-| |  | |  _ <|  _  | | | | '_ \\ 
-| |__| | |_) | | | | |_| | |_) |
-|_____/|____/|_| |_|\\__,_|_.__/ 
-                                
-v${version}${demoText} - Universal Database MCP Server
-`;
-}
-/**
- * Initialize and start the DBHub server
- */
-export async function main() {
-    try {
-        // Resolve DSN from command line args, environment variables, or .env files
-        const dsnData = resolveDSN();
-        if (!dsnData) {
-            const samples = ConnectorRegistry.getAllSampleDSNs();
-            const sampleFormats = Object.entries(samples)
-                .map(([id, dsn]) => `  - ${id}: ${dsn}`)
-                .join('\n');
-            console.error(`
-ERROR: Database connection string (DSN) is required.
-Please provide the DSN in one of these ways (in order of priority):
-
-1. Use demo mode: --demo (uses in-memory SQLite with sample employee database)
-2. Command line argument: --dsn="your-connection-string"
-3. Environment variable: export DSN="your-connection-string"
-4. .env file: DSN=your-connection-string
-
-Example formats:
-${sampleFormats}
-
-See documentation for more details on configuring database connections.
-`);
-            process.exit(1);
-        }
-        // Create MCP server
-        const server = new McpServer({
-            name: SERVER_NAME,
-            version: SERVER_VERSION
-        });
-        // Register resources, tools, and prompts
-        registerResources(server);
-        registerTools(server);
-        registerPrompts(server);
-        // Create connector manager and connect to database
-        const connectorManager = new ConnectorManager();
-        console.error(`Connecting with DSN: ${dsnData.dsn}`);
-        console.error(`DSN source: ${dsnData.source}`);
-        // If in demo mode, load the employee database
-        if (dsnData.isDemo) {
-            console.error('Running in demo mode with sample employee database');
-            const initScript = getSqliteInMemorySetupSql();
-            await connectorManager.connectWithDSN(dsnData.dsn, initScript);
-        }
-        else {
-            await connectorManager.connectWithDSN(dsnData.dsn);
-        }
-        // Resolve transport type
-        const transportData = resolveTransport();
-        console.error(`Using transport: ${transportData.type}`);
-        console.error(`Transport source: ${transportData.source}`);
-        // Print ASCII art banner with version and slogan
-        console.error(generateBanner(SERVER_VERSION, dsnData.isDemo));
-        // Set up transport based on type
-        if (transportData.type === 'sse') {
-            // Set up Express server for SSE transport
-            const app = express();
-            let transport;
-            app.get("/sse", async (req, res) => {
-                transport = new SSEServerTransport("/message", res);
-                console.error("Client connected", transport?.['_sessionId']);
-                await server.connect(transport);
-                // Listen for connection close
-                res.on('close', () => {
-                    console.error("Client Disconnected", transport?.['_sessionId']);
-                });
-            });
-            app.post("/message", async (req, res) => {
-                console.error("Client Message", transport?.['_sessionId']);
-                await transport.handlePostMessage(req, res, req.body);
-            });
-            // Start the HTTP server (port is only relevant for SSE transport)
-            const portData = resolvePort();
-            const port = portData.port;
-            console.error(`Port source: ${portData.source}`);
-            app.listen(port, () => {
-                console.error(`DBHub server listening at http://localhost:${port}`);
-                console.error(`Connect to MCP server at http://localhost:${port}/sse`);
-            });
-        }
-        else {
-            // Set up STDIO transport
-            const transport = new StdioServerTransport();
-            console.error("Starting with STDIO transport");
-            await server.connect(transport);
-            // Listen for SIGINT to gracefully shut down
-            process.on('SIGINT', async () => {
-                console.error('Shutting down...');
-                await transport.close();
-                process.exit(0);
-            });
-        }
-    }
-    catch (err) {
-        console.error("Fatal error:", err);
-        process.exit(1);
-    }
-}

package/dist/tools/index.js

@@ -1,11 +0,0 @@
-import { runQueryToolHandler, runQuerySchema } from './run-query.js';
-import { listConnectorsToolHandler } from './list-connectors.js';
-/**
- * Register all tool handlers with the MCP server
- */
-export function registerTools(server) {
-    // Tool to run a SQL query (read-only for safety)
-    server.tool("run_query", runQuerySchema, runQueryToolHandler);
-    // Tool to list available database connectors
-    server.tool("list_connectors", {}, listConnectorsToolHandler);
-}

package/dist/tools/list-connectors.js

@@ -1,43 +0,0 @@
-import { ConnectorManager } from '../connectors/manager.js';
-import { ConnectorRegistry } from '../connectors/interface.js';
-import { createToolSuccessResponse } from '../utils/response-formatter.js';
-import { isDemoMode } from '../config/env.js';
-/**
- * list_connectors tool handler
- * Lists all available database connectors and their sample DSNs
- * Indicates which connector is active based on current DSN
- */
-export async function listConnectorsToolHandler(_args, _extra) {
-    const connectors = ConnectorManager.getAvailableConnectors();
-    const samples = ConnectorRegistry.getAllSampleDSNs();
-    // Get active connector if possible
-    let activeConnectorId = null;
-    try {
-        // Check if we have an active connection using static method
-        const activeConnector = ConnectorManager.getCurrentConnector();
-        activeConnectorId = activeConnector.id;
-    }
-    catch (error) {
-        // No active connector yet or not connected
-    }
-    // If we're in demo mode, SQLite should be active
-    const isDemo = isDemoMode();
-    if (isDemo && !activeConnectorId) {
-        activeConnectorId = 'sqlite';
-    }
-    // Convert to a more structured format
-    const sampleObjects = Object.entries(samples).map(([id, dsn]) => ({
-        id,
-        dsn,
-        active: id === activeConnectorId
-    }));
-    // Prepare response data
-    const responseData = {
-        connectors: sampleObjects,
-        count: sampleObjects.length,
-        activeConnector: activeConnectorId,
-        demoMode: isDemo
-    };
-    // Use the utility to create a standardized response
-    return createToolSuccessResponse(responseData);
-}

package/dist/tools/run-query.js

@@ -1,32 +0,0 @@
-import { z } from "zod";
-import { ConnectorManager } from '../connectors/manager.js';
-import { createToolSuccessResponse, createToolErrorResponse } from '../utils/response-formatter.js';
-// Schema for run_query tool
-export const runQuerySchema = {
-    query: z.string().describe("SQL query to execute (SELECT only)")
-};
-/**
- * run_query tool handler
- * Executes a SQL query and returns the results
- */
-export async function runQueryToolHandler({ query }, _extra) {
-    const connector = ConnectorManager.getCurrentConnector();
-    try {
-        // Validate the query before execution
-        const validationResult = connector.validateQuery(query);
-        if (!validationResult.isValid) {
-            return createToolErrorResponse(validationResult.message ?? "Unknown validation error", "VALIDATION_ERROR");
-        }
-        // Execute the query if validation passed
-        const result = await connector.executeQuery(query);
-        // Build response data
-        const responseData = {
-            rows: result.rows,
-            count: result.rows.length
-        };
-        return createToolSuccessResponse(responseData);
-    }
-    catch (error) {
-        return createToolErrorResponse(error.message, "EXECUTION_ERROR");
-    }
-}

package/dist/utils/response-formatter.js

@@ -1,109 +0,0 @@
-/**
- * Response formatter utility for consistent API responses
- * Provides formatting for resources, tools, and prompts
- */
-/**
- * Create a success response with the given data
- */
-export function formatSuccessResponse(data, meta = {}) {
-    return {
-        success: true,
-        data,
-        ...(Object.keys(meta).length > 0 ? { meta } : {})
-    };
-}
-/**
- * Create an error response with the given message and code
- */
-export function formatErrorResponse(error, code = 'ERROR', details) {
-    return {
-        success: false,
-        error,
-        code,
-        ...(details ? { details } : {})
-    };
-}
-/**
- * Create a tool error response object
- */
-export function createToolErrorResponse(error, code = 'ERROR', details) {
-    return {
-        content: [{
-                type: "text",
-                text: JSON.stringify(formatErrorResponse(error, code, details), null, 2),
-                mimeType: "application/json"
-            }],
-        isError: true
-    };
-}
-/**
- * Create a tool success response object
- */
-export function createToolSuccessResponse(data, meta = {}) {
-    return {
-        content: [{
-                type: "text",
-                text: JSON.stringify(formatSuccessResponse(data, meta), null, 2),
-                mimeType: "application/json"
-            }]
-    };
-}
-/**
- * Create a resource error response object
- */
-export function createResourceErrorResponse(uri, error, code = 'ERROR', details) {
-    return {
-        contents: [{
-                uri,
-                text: JSON.stringify(formatErrorResponse(error, code, details), null, 2),
-                mimeType: "application/json"
-            }]
-    };
-}
-/**
- * Create a resource success response object
- */
-export function createResourceSuccessResponse(uri, data, meta = {}) {
-    return {
-        contents: [{
-                uri,
-                text: JSON.stringify(formatSuccessResponse(data, meta), null, 2),
-                mimeType: "application/json"
-            }]
-    };
-}
-/**
- * Format a successful prompt response in the MCP format
- */
-export function formatPromptSuccessResponse(text, references = []) {
-    return {
-        messages: [
-            {
-                role: 'assistant',
-                content: {
-                    type: 'text',
-                    text
-                }
-            }
-        ],
-        ...(references.length > 0 ? { references } : {})
-    };
-}
-/**
- * Format an error prompt response in the MCP format
- */
-export function formatPromptErrorResponse(error, code = 'ERROR') {
-    return {
-        messages: [
-            {
-                role: 'assistant',
-                content: {
-                    type: 'text',
-                    text: `Error: ${error}`
-                }
-            }
-        ],
-        error,
-        code
-    };
-}