postgres-scout-mcp 1.0.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Boban Lukic
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,234 @@
+# Postgres Scout MCP
+
+Scout your PostgreSQL databases with AI - A production-ready Model Context Protocol server with built-in safety features, monitoring, and data quality tools.
+
+## Setup
+
+### Claude Desktop / Claude Code
+
+Add to your MCP config (`~/.config/claude-desktop/config.json` or `~/.claude.json`):
+
+```json
+{
+  "mcpServers": {
+    "postgres-scout": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "postgres-scout-mcp",
+        "postgresql://localhost:5432/mydb"
+      ],
+      "type": "stdio"
+    }
+  }
+}
+```
+
+### Recommended: Separate Read-Only and Read-Write Instances
+
+The server runs in **read-only mode by default** for safety. For write operations, use a separate instance:
+
+```json
+{
+  "mcpServers": {
+    "postgres-scout-readonly": {
+      "command": "npx",
+      "args": ["-y", "postgres-scout-mcp", "--read-only", "postgresql://localhost:5432/production"],
+      "type": "stdio"
+    },
+    "postgres-scout-readwrite": {
+      "command": "npx",
+      "args": ["-y", "postgres-scout-mcp", "--read-write", "postgresql://localhost:5432/development"],
+      "type": "stdio"
+    }
+  }
+}
+```
+
+This gives you:
+- **postgres-scout-readonly**: Safe exploration without risk of data modification
+- **postgres-scout-readwrite**: Write operations available when explicitly needed
+- Clear separation of capabilities
+- Option to point read-write to a development database for extra safety
+
+### Global Install
+
+```bash
+npm install -g postgres-scout-mcp
+postgres-scout-mcp postgresql://localhost:5432/mydb
+```
+
+### Standalone Usage
+
+```bash
+# Default read-only mode (safest)
+postgres-scout-mcp
+
+# Explicitly enable read-write mode (use with caution)
+postgres-scout-mcp --read-write
+
+# With custom URI in read-only mode
+postgres-scout-mcp postgresql://localhost:5432/mydb
+
+# Read-write mode with custom connection
+postgres-scout-mcp --read-write postgresql://localhost:5432/mydb
+```
+
+### Command Line Options
+
+```
+--read-only          Run server in read-only mode (default)
+--read-write         Run server in read-write mode (enables all write operations)
+--mode <mode>        Set mode: 'read-only' or 'read-write'
+```
+
+### Environment Variables
+
+```bash
+# Security
+QUERY_TIMEOUT=30000         # milliseconds (default: 30s)
+MAX_RESULT_ROWS=10000       # prevent memory exhaustion
+ENABLE_RATE_LIMIT=true
+RATE_LIMIT_MAX_REQUESTS=100
+RATE_LIMIT_WINDOW_MS=60000  # 1 minute
+
+# Logging
+LOG_DIR=./logs
+LOG_LEVEL=info              # debug, info, warn, error
+
+# Connection Pool
+PGMAXPOOLSIZE=10
+PGMINPOOLSIZE=2
+PGIDLETIMEOUT=10000
+```
+
+## Security
+
+- **Read-only by default** — write operations must be explicitly enabled
+- All queries use parameterized values
+- SQL injection prevention with input validation and pattern detection
+- Identifier sanitization for table/column names
+- Rate limiting on all operations
+- Query timeouts to prevent long-running queries
+- Response size limits to prevent memory exhaustion
+
+## Available Tools
+
+### Read Operations (both modes)
+
+- **Database**: `listDatabases`, `getDatabaseStats`
+- **Schema**: `listSchemas`, `listTables`, `describeTable`
+- **Query**: `executeQuery`, `explainQuery`
+
+### Data Quality
+
+- `findDuplicates` — find duplicate rows based on column combinations
+- `findMissingValues` — NULL analysis across columns
+- `findOrphans` — find orphaned records via foreign key references
+- `checkConstraintViolations` — detect constraint issues
+- `analyzeTypeConsistency` — find type inconsistencies across rows
+
+### Export
+
+- `exportTable` — export to CSV, JSON, JSONL, or SQL
+- `generateInsertStatements` — generate INSERT statements with batching
+
+### Relationships
+
+- `exploreRelationships` — follow multi-hop relationships and discover dependencies
+- `analyzeForeignKeys` — analyze foreign key structure
+
+### Temporal Queries
+
+- `findRecent` — find rows within a time window
+- `analyzeTimeSeries` — time series analysis with anomaly detection
+- `detectSeasonality` — detect seasonal patterns
+
+### Monitoring
+
+- `getCurrentActivity` — active queries and connections
+- `analyzeLocks` — lock analysis
+- `getIndexUsage` — index usage statistics
+
+### Live Monitoring
+
+- `getLiveMetrics` — real-time performance metrics
+- `getHottestTables` — identify most active tables
+- `getTableMetrics` — detailed metrics per table
+
+### Maintenance & Optimization
+
+- `getHealthScore` — overall database health score
+- `getSlowQueries` — slow query analysis (requires `pg_stat_statements`)
+- `analyzeTableBloat` — table bloat analysis
+- `suggestVacuum` — VACUUM recommendations
+- `suggestIndexes` — index recommendations
+- `suggestPartitioning` — partitioning suggestions
+- `detectAnomalies` — anomaly detection
+- `optimizeQuery` — query optimization suggestions
+
+### Write Operations (read-write mode only)
+
+- `previewUpdate`, `previewDelete` — preview changes before applying
+- `safeUpdate` — UPDATE with row limits and preview
+- `safeDelete` — DELETE with row limits and preview
+- `safeInsert` — INSERT with validation
+
+## Logging
+
+File logging is **disabled by default**. Enable it with the `ENABLE_LOGGING=true` environment variable:
+
+```json
+{
+  "mcpServers": {
+    "postgres-scout": {
+      "command": "npx",
+      "args": ["-y", "postgres-scout-mcp", "postgresql://localhost:5432/mydb"],
+      "env": { "ENABLE_LOGGING": "true", "LOG_DIR": "./logs" },
+      "type": "stdio"
+    }
+  }
+}
+```
+
+When enabled, two log files are created in `LOG_DIR` (defaults to `./logs`):
+
+- **tool-usage.log**: Every tool call with timestamp, tool name, and arguments
+- **error.log**: Errors with stack traces and the arguments that caused them
+
+## Examples
+
+### Basic Operations
+```
+executeQuery({ query: "SELECT id, email FROM users WHERE status = $1 LIMIT 10", params: ["active"] })
+explainQuery({ query: "SELECT * FROM orders WHERE customer_id = $1", params: [123], analyze: true })
+listTables({ schema: "public" })
+```
+
+### Data Quality
+```
+findDuplicates({ table: "users", columns: ["email"] })
+findOrphans({ table: "orders", column: "customer_id", referencedTable: "customers", referencedColumn: "id" })
+findMissingValues({ table: "users", columns: ["email", "phone"] })
+```
+
+### Monitoring
+```
+getLiveMetrics({ metrics: ["queries", "connections", "cache"], duration: 30000, interval: 1000 })
+getHottestTables({ limit: 5, orderBy: "seq_scan" })
+getSlowQueries({ minDurationMs: 100, limit: 10 })
+```
+
+## Development
+
+```bash
+git clone https://github.com/bluwork/postgres-scout-mcp.git
+cd postgres-scout-mcp
+pnpm install
+pnpm build
+pnpm test
+```
+
+## License
+
+Apache-2.0

package/bin/cli.js

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { spawnSync } from 'child_process';
+
+// Get the directory of the current module
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Parse command line arguments
+const args = process.argv.slice(2);
+const helpText = `
+Postgres Scout MCP - PostgreSQL Model Context Protocol Server
+
+Usage:
+  postgres-scout-mcp [options] [postgresql-uri]
+
+Options:
+  --help, -h         Show this help message
+  --version, -v      Show version number
+  --read-only        Run server in read-only mode (default)
+  --read-write       Run server in read-write mode (enables all write operations)
+  --mode <mode>      Set mode: 'read-only' or 'read-write'
+
+Arguments:
+  postgresql-uri     PostgreSQL connection URI (default: postgresql://localhost:5432/postgres)
+
+Examples:
+  postgres-scout-mcp
+  postgres-scout-mcp --read-write postgresql://localhost:5432/mydb
+  postgres-scout-mcp --mode read-only postgresql://localhost:5432/mydb
+`;
+
+// Handle command-line options
+if (args.includes('--help') || args.includes('-h')) {
+  console.log(helpText);
+  process.exit(0);
+}
+
+if (args.includes('--version') || args.includes('-v')) {
+  // Read version from package.json
+  try {
+    const packageJsonPath = join(__dirname, '..', 'package.json');
+    const packageJson = await import(packageJsonPath, { with: { type: 'json' } });
+    console.log(`Postgres Scout MCP v${packageJson.default.version}`);
+    process.exit(0);
+  } catch (error) {
+    console.error(
+      'Could not determine version:',
+      error instanceof Error ? error.message : String(error)
+    );
+    process.exit(1);
+  }
+}
+
+const filteredArgs = args.filter((arg) => !['--help', '-h', '--version', '-v'].includes(arg));
+
+// Launch the actual MCP server
+const serverPath = join(__dirname, '..', 'dist', 'index.js');
+const nodeProcess = spawnSync('node', [serverPath, ...filteredArgs], {
+  stdio: 'inherit',
+  shell: process.platform === 'win32',
+});
+
+// Forward the exit code from the child process
+process.exit(nodeProcess.status || 0);

package/dist/config/environment.js

@@ -0,0 +1,52 @@
+import { parseIntSafe } from '../utils/sanitize.js';
+export function parseCommandLineArgs(args) {
+    let mode = 'read-only';
+    let connectionString = '';
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg === '--read-write' || arg === '-w') {
+            mode = 'read-write';
+        }
+        else if (arg === '--read-only' || arg === '-r') {
+            mode = 'read-only';
+        }
+        else if (!arg.startsWith('-')) {
+            connectionString = arg;
+        }
+    }
+    if (!connectionString) {
+        connectionString = process.env.DATABASE_URL || '';
+    }
+    if (!connectionString) {
+        throw new Error('Database connection string required. Provide as argument or set DATABASE_URL environment variable.');
+    }
+    return { mode, connectionString };
+}
+export function createServerConfig(args) {
+    return {
+        mode: args.mode,
+        connectionString: args.connectionString,
+        queryTimeout: parseIntSafe(process.env.QUERY_TIMEOUT || '30000', 30000),
+        maxResultRows: parseIntSafe(process.env.MAX_RESULT_ROWS || '10000', 10000),
+        enableRateLimit: process.env.ENABLE_RATE_LIMIT !== 'false',
+        rateLimitMaxRequests: parseIntSafe(process.env.RATE_LIMIT_MAX_REQUESTS || '100', 100),
+        rateLimitWindowMs: parseIntSafe(process.env.RATE_LIMIT_WINDOW_MS || '60000', 60000),
+        logDir: process.env.LOG_DIR || './logs',
+        logLevel: process.env.LOG_LEVEL || 'info'
+    };
+}
+export function validateConfig(config) {
+    if (!config.connectionString) {
+        throw new Error('Connection string is required');
+    }
+    if (config.queryTimeout < 1000 || config.queryTimeout > 600000) {
+        throw new Error('Query timeout must be between 1000ms and 600000ms');
+    }
+    if (config.maxResultRows < 1 || config.maxResultRows > 100000) {
+        throw new Error('Max result rows must be between 1 and 100000');
+    }
+    if (!['read-only', 'read-write'].includes(config.mode)) {
+        throw new Error('Mode must be either "read-only" or "read-write"');
+    }
+}
+//# sourceMappingURL=environment.js.map

package/dist/index.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+import { parseCommandLineArgs, createServerConfig, validateConfig } from './config/environment.js';
+import { createLogger } from './utils/logger.js';
+import { createDatabaseConnection, closeDatabaseConnection } from './utils/database.js';
+import { createMCPServer, startServer } from './server/setup.js';
+async function main() {
+    let logger;
+    let connection;
+    try {
+        const args = parseCommandLineArgs(process.argv.slice(2));
+        const config = createServerConfig(args);
+        validateConfig(config);
+        logger = createLogger(config.logDir, config.logLevel);
+        logger.info('main', 'Starting Postgres Scout MCP', {
+            mode: config.mode,
+            logLevel: config.logLevel
+        });
+        connection = await createDatabaseConnection(config, logger);
+        logger.info('main', 'Database connection established', {
+            database: connection.pool.options.database
+        });
+        const server = createMCPServer(connection, logger, config);
+        await startServer(server, logger);
+        const shutdown = async () => {
+            if (logger) {
+                logger.info('main', 'Shutting down...');
+            }
+            if (connection && logger) {
+                await closeDatabaseConnection(connection, logger);
+            }
+            process.exit(0);
+        };
+        process.on('SIGINT', shutdown);
+        process.on('SIGTERM', shutdown);
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        if (logger) {
+            logger.error('main', 'Fatal error', { error: errorMessage });
+        }
+        else {
+            console.error('Fatal error:', errorMessage);
+        }
+        if (connection) {
+            try {
+                await closeDatabaseConnection(connection, logger);
+            }
+            catch (closeError) {
+                console.error('Error closing connection:', closeError);
+            }
+        }
+        process.exit(1);
+    }
+}
+main().catch((error) => {
+    console.error('Unhandled error:', error);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map