@bytebase/dbhub 0.6.1 → 0.7.0

package/README.md

@@ -6,6 +6,10 @@
 </a>
 </p>
 
+<p align="center">
+  <a href="https://cursor.com/install-mcp?name=dbhub&config=eyJjb21tYW5kIjoibnB4IEBieXRlYmFzZS9kYmh1YiIsImVudiI6eyJUUkFOU1BPUlQiOiJzdGRpbyIsIkRTTiI6InBvc3RncmVzOi8vdXNlcjpwYXNzd29yZEBsb2NhbGhvc3Q6NTQzMi9kYm5hbWU%2Fc3NsbW9kZT1kaXNhYmxlIiwiUkVBRE9OTFkiOiJ0cnVlIn19"><img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Add dbhub MCP server to Cursor" height="32" /></a>
+</p>
+
 DBHub is a universal database gateway implementing the Model Context Protocol (MCP) server interface. This gateway allows MCP-compatible clients to connect to and explore different databases.
 
 ```bash
@@ -52,7 +56,6 @@ https://demo.dbhub.ai/message connects a [sample employee database](https://gith
 | Tool            | Command Name      | Description                                                         | PostgreSQL | MySQL | MariaDB | SQL Server | SQLite | Oracle |
 | --------------- | ----------------- | ------------------------------------------------------------------- | :--------: | :---: | :-----: | :--------: | ------ | :----: |
 | Execute SQL     | `execute_sql`     | Execute single or multiple SQL statements (separated by semicolons) |     ✅     |  ✅   |   ✅    |     ✅     | ✅     |   ✅   |
-| List Connectors | `list_connectors` | List all available database connectors                              |     ✅     |  ✅   |   ✅    |     ✅     | ✅     |   ✅   |
 
 ### Prompt Capabilities
 
@@ -168,6 +171,8 @@ npx @bytebase/dbhub --transport http --port 8080 --demo
 
 ### Cursor
 
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=dbhub&config=eyJjb21tYW5kIjoibnB4IEBieXRlYmFzZS9kYmh1YiIsImVudiI6eyJUUkFOU1BPUlQiOiJzdGRpbyIsIkRTTiI6InBvc3RncmVzOi8vdXNlcjpwYXNzd29yZEBsb2NhbGhvc3Q6NTQzMi9kYm5hbWU%2Fc3NsbW9kZT1kaXNhYmxlIiwiUkVBRE9OTFkiOiJ0cnVlIn19)
+
 ![cursor](https://raw.githubusercontent.com/bytebase/dbhub/main/resources/images/cursor.webp)
 
 - Cursor supports both `stdio` and `http`.
@@ -229,6 +234,9 @@ You can use DBHub in demo mode with a sample employee database for testing:
 npx @bytebase/dbhub  --demo
 ```
 
+> [!WARNING]
+If your user/password contains special characters, you need to escape them first. (e.g. `pass#word` should be escaped as `pass%23word`)
+
 For real databases, a Database Source Name (DSN) is required. You can provide this in several ways:
 
 - **Command line argument** (highest priority):
@@ -309,13 +317,13 @@ Extra query parameters:
 
 ### Command line options
 
-| Option    | Description                                                     | Default                      |
-| --------- | --------------------------------------------------------------- | ---------------------------- |
-| demo      | Run in demo mode with sample employee database                  | `false`                      |
-| dsn       | Database connection string                                      | Required if not in demo mode |
-| transport | Transport mode: `stdio` or `http`                               | `stdio`                      |
-| port      | HTTP server port (only applicable when using `--transport=http`) | `8080`                       |
-| readonly  | Restrict SQL execution to read-only operations                  | `false`                      |
+| Option    | Environment Variable | Description                                                     | Default                      |
+| --------- | -------------------- | --------------------------------------------------------------- | ---------------------------- |
+| dsn       | `DSN`                | Database connection string                                      | Required if not in demo mode |
+| transport | `TRANSPORT`          | Transport mode: `stdio` or `http`                               | `stdio`                      |
+| port      | `PORT`               | HTTP server port (only applicable when using `--transport=http`) | `8080`                       |
+| readonly  | `READONLY`           | Restrict SQL execution to read-only operations                  | `false`                      |
+| demo      | N/A                  | Run in demo mode with sample employee database                  | `false`                      |
 
 The demo mode uses an in-memory SQLite database loaded with the [sample employee database](https://github.com/bytebase/dbhub/tree/main/resources/employee-sqlite) that includes tables for employees, departments, titles, salaries, department employees, and department managers. The sample database includes SQL scripts for table creation, data loading, and testing.
 

package/dist/index.js

@@ -2939,34 +2939,6 @@ async function executeSqlToolHandler({ sql: sql2 }, _extra) {
   }
 }
 
-// src/tools/list-connectors.ts
-async function listConnectorsToolHandler(_args, _extra) {
-  const samples = ConnectorRegistry.getAllSampleDSNs();
-  let activeConnectorType = null;
-  try {
-    const activeConnector = ConnectorManager.getCurrentConnector();
-    activeConnectorType = activeConnector.id;
-  } catch (error) {
-  }
-  const isDemo = isDemoMode();
-  if (isDemo && !activeConnectorType) {
-    activeConnectorType = "sqlite";
-  }
-  const sampleObjects = Object.entries(samples).map(([id, dsn]) => ({
-    id,
-    dsn,
-    active: id === activeConnectorType
-  }));
-  const responseData = {
-    connectors: sampleObjects,
-    count: sampleObjects.length,
-    activeConnector: activeConnectorType,
-    demoMode: isDemo,
-    readonlyMode: isReadOnlyMode()
-  };
-  return createToolSuccessResponse(responseData);
-}
-
 // src/tools/index.ts
 function registerTools(server) {
   server.tool(
@@ -2975,12 +2947,6 @@ function registerTools(server) {
     executeSqlSchema,
     executeSqlToolHandler
   );
-  server.tool(
-    "list_connectors",
-    "List all available database connectors",
-    {},
-    listConnectorsToolHandler
-  );
 }
 
 // src/prompts/sql-generator.ts
@@ -3515,9 +3481,9 @@ See documentation for more details on configuring database connections.
       const portData = resolvePort();
       const port = portData.port;
       console.error(`Port source: ${portData.source}`);
-      app.listen(port, "localhost", () => {
-        console.error(`DBHub server listening at http://localhost:${port}`);
-        console.error(`Connect to MCP server at http://localhost:${port}/message`);
+      app.listen(port, "0.0.0.0", () => {
+        console.error(`DBHub server listening at http://0.0.0.0:${port}`);
+        console.error(`Connect to MCP server at http://0.0.0.0:${port}/message`);
       });
     } else {
       const server = createServer();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytebase/dbhub",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Universal Database MCP Server",
   "main": "dist/index.js",
   "type": "module",