redash-mcp 3.1.3 → 3.1.4

package/dist/query-cache.js

@@ -1,87 +0,0 @@
-import { createHash } from "crypto";
-const cache = new Map();
-let totalSizeBytes = 0;
-function getCacheTtlMs() {
-    const ttl = parseInt(process.env.REDASH_MCP_CACHE_TTL ?? "300", 10);
-    return (isNaN(ttl) ? 300 : ttl) * 1000;
-}
-function getMaxSizeBytes() {
-    const mb = parseInt(process.env.REDASH_MCP_CACHE_MAX_MB ?? "50", 10);
-    return (isNaN(mb) ? 50 : mb) * 1024 * 1024;
-}
-function normalizeSQL(sql) {
-    return sql
-        .replace(/--[^\n]*/g, " ")
-        .replace(/\/\*[\s\S]*?\*\//g, " ")
-        .replace(/\s+/g, " ")
-        .trim()
-        .toLowerCase();
-}
-function makeCacheKey(dataSourceId, sql) {
-    return createHash("sha256")
-        .update(`${dataSourceId}:${normalizeSQL(sql)}`)
-        .digest("hex");
-}
-function roughSize(obj) {
-    return JSON.stringify(obj).length * 2;
-}
-function purgeExpired(ttl) {
-    if (ttl === 0)
-        return;
-    const now = Date.now();
-    for (const [key, entry] of cache) {
-        if (now - entry.ts > ttl) {
-            totalSizeBytes -= entry.size;
-            cache.delete(key);
-        }
-    }
-}
-export function getCached(dataSourceId, sql) {
-    const ttl = getCacheTtlMs();
-    if (ttl === 0)
-        return null;
-    const key = makeCacheKey(dataSourceId, sql);
-    const entry = cache.get(key);
-    if (!entry)
-        return null;
-    if (Date.now() - entry.ts > ttl) {
-        totalSizeBytes -= entry.size;
-        cache.delete(key);
-        return null;
-    }
-    // Touch entry to maintain LRU order via insertion-order Map semantics.
-    cache.delete(key);
-    cache.set(key, entry);
-    return entry.result;
-}
-export function setCached(dataSourceId, sql, result) {
-    const ttl = getCacheTtlMs();
-    if (ttl === 0)
-        return;
-    const maxSize = getMaxSizeBytes();
-    const size = roughSize(result);
-    if (size > maxSize * 0.2)
-        return;
-    purgeExpired(ttl);
-    while (totalSizeBytes + size > maxSize && cache.size > 0) {
-        const oldestKey = cache.keys().next().value;
-        if (!oldestKey)
-            break;
-        const old = cache.get(oldestKey);
-        totalSizeBytes -= old.size;
-        cache.delete(oldestKey);
-    }
-    const key = makeCacheKey(dataSourceId, sql);
-    const existing = cache.get(key);
-    if (existing)
-        totalSizeBytes -= existing.size;
-    cache.set(key, { result, ts: Date.now(), size });
-    totalSizeBytes += size;
-}
-export function getCacheStats() {
-    return {
-        entries: cache.size,
-        sizeMb: (totalSizeBytes / 1024 / 1024).toFixed(2),
-        ttlSecs: getCacheTtlMs() / 1000,
-    };
-}

package/dist/redash-client.js

@@ -1,124 +0,0 @@
-function validateRedashUrl(raw) {
-    if (raw === undefined)
-        return undefined;
-    const trimmed = raw.trim();
-    if (trimmed.length === 0)
-        return undefined;
-    if (/[\n\r]/.test(raw)) {
-        throw new Error("REDASH_URL must not contain newlines");
-    }
-    let parsed;
-    try {
-        parsed = new URL(trimmed);
-    }
-    catch {
-        throw new Error(`REDASH_URL is not a valid URL: ${raw}`);
-    }
-    if (parsed.username || parsed.password) {
-        throw new Error("REDASH_URL must not contain credentials");
-    }
-    if (parsed.protocol !== "http:" && parsed.protocol !== "https:") {
-        throw new Error(`REDASH_URL must use http or https scheme, got: ${parsed.protocol}`);
-    }
-    return trimmed.replace(/\/$/, "");
-}
-const REDASH_URL = validateRedashUrl(process.env.REDASH_URL);
-const REDASH_API_KEY = process.env.REDASH_API_KEY;
-const HTTP_TIMEOUT_MS = (() => {
-    const raw = parseInt(process.env.REDASH_HTTP_TIMEOUT_SECS ?? "30", 10);
-    return (isNaN(raw) || raw <= 0 ? 30 : raw) * 1000;
-})();
-export { REDASH_URL, REDASH_API_KEY };
-export async function redashFetch(path, options) {
-    const controller = new AbortController();
-    const timer = setTimeout(() => controller.abort(), HTTP_TIMEOUT_MS);
-    let res;
-    try {
-        res = await fetch(`${REDASH_URL}/api${path}`, {
-            ...options,
-            signal: options?.signal ?? controller.signal,
-            headers: {
-                "Authorization": `Key ${REDASH_API_KEY}`,
-                "Content-Type": "application/json",
-                ...options?.headers,
-            },
-        });
-    }
-    catch (err) {
-        if (err?.name === "AbortError") {
-            throw new Error(`Redash request timed out after ${HTTP_TIMEOUT_MS / 1000}s`);
-        }
-        throw err;
-    }
-    finally {
-        clearTimeout(timer);
-    }
-    if (!res.ok) {
-        let hint = "";
-        if (res.status === 401)
-            hint = " (Check your REDASH_API_KEY)";
-        else if (res.status === 403)
-            hint = " (Access denied for this resource)";
-        else if (res.status === 404)
-            hint = " (Resource not found. Check the ID)";
-        throw new Error(`Redash API error: ${res.status} ${res.statusText}${hint}`);
-    }
-    if (res.status === 204 || res.headers.get("content-length") === "0") {
-        return null;
-    }
-    return res.json();
-}
-export async function pollQueryResult(jobId, timeoutSecs = 30) {
-    const deadline = Date.now() + timeoutSecs * 1000;
-    let delayMs = 250;
-    while (Date.now() < deadline) {
-        const job = await redashFetch(`/jobs/${jobId}`);
-        if (job.job.status === 3) {
-            return await redashFetch(`/query_results/${job.job.query_result_id}`);
-        }
-        if (job.job.status === 4) {
-            throw new Error(`Query failed: ${job.job.error}`);
-        }
-        const remaining = deadline - Date.now();
-        if (remaining <= 0)
-            break;
-        await new Promise((r) => setTimeout(r, Math.min(delayMs, remaining)));
-        delayMs = Math.min(delayMs * 2, 2000);
-    }
-    throw new Error(`Query timed out after ${timeoutSecs}s`);
-}
-export function formatAsMarkdownTable(columns, rows) {
-    const escape = (s) => s.replace(/\|/g, "\\|");
-    const header = `| ${columns.map(escape).join(" | ")} |`;
-    const separator = `| ${columns.map(() => "---").join(" | ")} |`;
-    const body = rows
-        .map((row) => `| ${columns.map((c) => escape(String(row[c] ?? ""))).join(" | ")} |`)
-        .join("\n");
-    return `${header}\n${separator}\n${body}`;
-}
-const schemaCache = new Map();
-const CACHE_TTL_MS = 10 * 60 * 1000;
-const SCHEMA_CACHE_MAX_ENTRIES = 32;
-export async function fetchSchema(dataSourceId) {
-    const cached = schemaCache.get(dataSourceId);
-    if (cached && Date.now() - cached.ts < CACHE_TTL_MS) {
-        schemaCache.delete(dataSourceId);
-        schemaCache.set(dataSourceId, cached);
-        return cached.schema;
-    }
-    if (cached)
-        schemaCache.delete(dataSourceId);
-    const result = await redashFetch(`/data_sources/${dataSourceId}/schema`);
-    const schema = (result.schema ?? []).map((table) => ({
-        ...table,
-        columns: (table.columns ?? []).map((c) => typeof c === "string" ? { name: c, type: "unknown" } : c),
-    }));
-    while (schemaCache.size >= SCHEMA_CACHE_MAX_ENTRIES) {
-        const oldest = schemaCache.keys().next().value;
-        if (oldest === undefined)
-            break;
-        schemaCache.delete(oldest);
-    }
-    schemaCache.set(dataSourceId, { schema, ts: Date.now() });
-    return schema;
-}

package/dist/setup.js

@@ -1,137 +0,0 @@
-#!/usr/bin/env node
-import * as fs from "fs";
-import * as path from "path";
-import * as os from "os";
-import { execSync } from "child_process";
-import * as p from "@clack/prompts";
-function findNpxPath() {
-    try {
-        const result = execSync("which npx", { encoding: "utf8" }).trim();
-        if (result)
-            return result;
-    }
-    catch { }
-    const candidates = [
-        "/usr/local/bin/npx",
-        "/opt/homebrew/bin/npx",
-        "/usr/bin/npx",
-    ];
-    for (const c of candidates) {
-        if (fs.existsSync(c))
-            return c;
-    }
-    return "npx";
-}
-function getDesktopConfigPath() {
-    const platform = os.platform();
-    if (platform === "darwin") {
-        return path.join(os.homedir(), "Library", "Application Support", "Claude", "claude_desktop_config.json");
-    }
-    else if (platform === "win32") {
-        return path.join(process.env.APPDATA ?? "", "Claude", "claude_desktop_config.json");
-    }
-    else {
-        return path.join(os.homedir(), ".config", "Claude", "claude_desktop_config.json");
-    }
-}
-function getClaudeCodeConfigPath() {
-    return path.join(os.homedir(), ".claude", "settings.json");
-}
-export async function main() {
-    p.intro("redash-mcp setup wizard");
-    const targets = await p.multiselect({
-        message: "Select installation targets (space to select, enter to confirm)",
-        options: [
-            { value: "desktop", label: "Claude Desktop" },
-            { value: "cli", label: "Claude Code (CLI)" },
-        ],
-        required: true,
-    });
-    if (p.isCancel(targets)) {
-        p.cancel("Setup cancelled.");
-        process.exit(0);
-    }
-    const redashUrl = await p.text({
-        message: "Enter your Redash URL",
-        placeholder: "https://redash.example.com",
-        validate(value) {
-            if (!value)
-                return "URL is required.";
-            if (!value.startsWith("http://") && !value.startsWith("https://"))
-                return "Must start with http:// or https://";
-        },
-    });
-    if (p.isCancel(redashUrl)) {
-        p.cancel("Setup cancelled.");
-        process.exit(0);
-    }
-    const apiKey = await p.text({
-        message: "Enter your Redash API key",
-        validate(value) {
-            if (!value)
-                return "API key is required.";
-        },
-    });
-    if (p.isCancel(apiKey)) {
-        p.cancel("Setup cancelled.");
-        process.exit(0);
-    }
-    const url = redashUrl.replace(/\/$/, "");
-    const npxPath = findNpxPath();
-    const mcpEntry = {
-        command: npxPath,
-        args: ["-y", "redash-mcp"],
-        env: {
-            REDASH_URL: url,
-            REDASH_API_KEY: apiKey,
-        },
-    };
-    const s = p.spinner();
-    if (targets.includes("desktop")) {
-        s.start("Configuring Claude Desktop...");
-        setupDesktop(mcpEntry);
-        s.stop("Claude Desktop configured");
-    }
-    if (targets.includes("cli")) {
-        s.start("Configuring Claude Code (CLI)...");
-        setupClaudeCode(mcpEntry);
-        s.stop("Claude Code (CLI) configured");
-    }
-    p.outro("Setup complete. Restart to start using redash-mcp.");
-}
-function setupDesktop(mcpEntry) {
-    const configPath = getDesktopConfigPath();
-    let config = { mcpServers: {} };
-    if (fs.existsSync(configPath)) {
-        try {
-            config = JSON.parse(fs.readFileSync(configPath, "utf8"));
-            config.mcpServers ??= {};
-        }
-        catch {
-            throw new Error(`Failed to read claude_desktop_config.json: ${configPath}`);
-        }
-    }
-    else {
-        fs.mkdirSync(path.dirname(configPath), { recursive: true });
-    }
-    config.mcpServers["redash-mcp"] = mcpEntry;
-    fs.writeFileSync(configPath, JSON.stringify(config, null, 2), "utf8");
-}
-function setupClaudeCode(mcpEntry) {
-    const configPath = getClaudeCodeConfigPath();
-    let config = {};
-    if (fs.existsSync(configPath)) {
-        try {
-            config = JSON.parse(fs.readFileSync(configPath, "utf8"));
-        }
-        catch {
-            throw new Error(`Failed to read Claude Code settings.json: ${configPath}`);
-        }
-    }
-    else {
-        fs.mkdirSync(path.dirname(configPath), { recursive: true });
-    }
-    config.mcpServers ??= {};
-    config.mcpServers["redash-mcp"] = mcpEntry;
-    fs.writeFileSync(configPath, JSON.stringify(config, null, 2), "utf8");
-}

package/dist/sql-guard.js

@@ -1,151 +0,0 @@
-function getConfig() {
-    const raw = process.env.REDASH_SAFETY_MODE ?? "warn";
-    const mode = ["off", "warn", "strict"].includes(raw) ? raw : "warn";
-    return {
-        mode,
-        disablePii: process.env.REDASH_SAFETY_DISABLE_PII === "true",
-        disableCost: process.env.REDASH_SAFETY_DISABLE_COST === "true",
-        autoLimit: parseInt(process.env.REDASH_AUTO_LIMIT ?? "0", 10) || 0,
-    };
-}
-function normalizeForAnalysis(sql) {
-    return sql
-        .replace(/--[^\n]*/g, " ")
-        .replace(/\/\*[\s\S]*?\*\//g, " ")
-        .replace(/\s+/g, " ")
-        .trim()
-        .toUpperCase();
-}
-function hasWhere(sql) {
-    return /\bWHERE\b/.test(sql);
-}
-function hasLimit(sql) {
-    return /\bLIMIT\b/.test(sql);
-}
-function isSelect(sql) {
-    return /^\s*(SELECT|WITH)\b/i.test(sql);
-}
-function injectLimit(sql, limit) {
-    if (/\bLIMIT\b/i.test(sql))
-        return sql;
-    if (!isSelect(sql))
-        return sql;
-    return `${sql.trimEnd()} LIMIT ${limit}`;
-}
-export function analyzeQuery(sql) {
-    const config = getConfig();
-    if (config.mode === "off") {
-        return { blocked: false, warnings: [], message: "" };
-    }
-    const upper = normalizeForAnalysis(sql);
-    const warnings = [];
-    let modifiedQuery;
-    if (/\bDROP\s+(TABLE|DATABASE|SCHEMA|VIEW|INDEX|FUNCTION)\b/.test(upper)) {
-        return {
-            blocked: true,
-            warnings: [],
-            message: "🚫 Query blocked.\n\nReason: DROP statements permanently delete data/schema.\nRule: DESTRUCTIVE / DROP\n\nSet REDASH_SAFETY_MODE=off to disable this check.",
-        };
-    }
-    if (/\bTRUNCATE\b/.test(upper)) {
-        return {
-            blocked: true,
-            warnings: [],
-            message: "🚫 Query blocked.\n\nReason: TRUNCATE deletes all data from the table.\nRule: DESTRUCTIVE / TRUNCATE",
-        };
-    }
-    if (/\bALTER\s+TABLE\b/.test(upper)) {
-        return {
-            blocked: true,
-            warnings: [],
-            message: "🚫 Query blocked.\n\nReason: ALTER TABLE modifies schema and requires prior coordination.\nRule: DESTRUCTIVE / ALTER_TABLE",
-        };
-    }
-    if (/\b(GRANT|REVOKE)\b/.test(upper)) {
-        return {
-            blocked: true,
-            warnings: [],
-            message: "🚫 Query blocked.\n\nReason: GRANT/REVOKE permission changes are not allowed.\nRule: DESTRUCTIVE / PRIVILEGE_CHANGE",
-        };
-    }
-    if (/\bDELETE\s+FROM\b/.test(upper) && !hasWhere(upper)) {
-        return {
-            blocked: true,
-            warnings: [],
-            message: "🚫 Query blocked.\n\nReason: DELETE without WHERE clause will delete all rows.\nRule: DESTRUCTIVE / DELETE_WITHOUT_WHERE\n\nSafe example:\n  DELETE FROM orders WHERE created_at < '2024-01-01'",
-        };
-    }
-    if (/\bUPDATE\b/.test(upper) && /\bSET\b/.test(upper) && !hasWhere(upper)) {
-        return {
-            blocked: true,
-            warnings: [],
-            message: "🚫 Query blocked.\n\nReason: UPDATE without WHERE clause will modify all rows.\nRule: DESTRUCTIVE / UPDATE_WITHOUT_WHERE\n\nSafe example:\n  UPDATE orders SET status = 'cancelled' WHERE created_at < '2024-01-01'",
-        };
-    }
-    if (/\bDELETE\s+FROM\b/.test(upper)) {
-        warnings.push("[DESTRUCTIVE] DELETE query detected. Please verify the WHERE clause.");
-    }
-    if (/\bUPDATE\b/.test(upper) && /\bSET\b/.test(upper)) {
-        warnings.push("[DESTRUCTIVE] UPDATE query detected. Please verify the WHERE clause.");
-    }
-    if (!config.disableCost && isSelect(sql)) {
-        const hasSelectStar = /SELECT\s+\*/.test(upper) || /SELECT\s+[\w.]+\.\*/.test(upper);
-        const noWhere = !hasWhere(upper);
-        const noLimit = !hasLimit(upper);
-        if (hasSelectStar) {
-            warnings.push("[COST] SELECT * detected. Specify only needed columns to reduce scan costs.");
-        }
-        if (noWhere) {
-            warnings.push("[COST] No WHERE clause. Consider adding date or condition filters.");
-        }
-        if (noLimit) {
-            if (config.autoLimit > 0) {
-                modifiedQuery = injectLimit(sql, config.autoLimit);
-                warnings.push(`[COST] No LIMIT clause — auto-appended LIMIT ${config.autoLimit}. Specify an explicit LIMIT if you need all rows.`);
-            }
-            else {
-                warnings.push("[COST] No LIMIT clause. Full table scans on large tables may incur significant costs.");
-            }
-        }
-        if (config.mode === "strict") {
-            const costWarnings = warnings.filter((w) => w.startsWith("[COST]"));
-            if (costWarnings.length > 0) {
-                return {
-                    blocked: true,
-                    warnings: [],
-                    message: `🚫 Query blocked (strict mode).\n\n${costWarnings.join("\n")}\n\nSet REDASH_SAFETY_MODE=warn to allow with warnings.`,
-                };
-            }
-        }
-    }
-    if (!config.disablePii) {
-        const piiPatterns = [
-            "EMAIL",
-            "PHONE",
-            "PASSWORD",
-            "PASSWD",
-            "SSN",
-            "SOCIAL_SECURITY",
-            "CREDIT_CARD",
-            "CARD_NUMBER",
-        ];
-        const matched = piiPatterns.filter((k) => upper.includes(k));
-        if (matched.length > 0) {
-            warnings.push(`[PII] Sensitive data columns detected: ${matched.join(", ")}. Please verify your data privacy compliance.`);
-        }
-        if (config.mode === "strict") {
-            const piiWarnings = warnings.filter((w) => w.startsWith("[PII]"));
-            if (piiWarnings.length > 0) {
-                return {
-                    blocked: true,
-                    warnings: [],
-                    message: `🚫 Query blocked (strict mode).\n\n${piiWarnings.join("\n")}\n\nSet REDASH_SAFETY_MODE=warn to allow with warnings.`,
-                };
-            }
-        }
-    }
-    const message = warnings.length > 0
-        ? `⚠️ Safety warnings (query will still execute)\n\n${warnings.join("\n")}\n\n---`
-        : "";
-    return { blocked: false, warnings, message, modifiedQuery };
-}

package/dist/tool-error.js

@@ -1,40 +0,0 @@
-/**
- * Shared error handler for MCP tool callbacks.
- * Logs the full error to stderr for debugging, then returns a
- * user-friendly MCP error response without leaking internal details.
- */
-export function handleToolError(toolName, error) {
-    const detail = error instanceof Error ? error.message : String(error);
-    // Log full detail to stderr so operators can debug.
-    console.error(`[${toolName}] ${detail}`);
-    // Derive a safe, user-facing message.
-    let userMessage;
-    if (detail.includes("Query timed out")) {
-        userMessage = "The query timed out. Try simplifying the query or increasing timeout_secs.";
-    }
-    else if (detail.includes("Query failed")) {
-        userMessage = "The query execution failed. Please check the SQL syntax and try again.";
-    }
-    else if (detail.includes("401") || detail.includes("Check your REDASH_API_KEY")) {
-        userMessage = "Authentication failed. Please verify your Redash API key.";
-    }
-    else if (detail.includes("403") || detail.includes("Access denied")) {
-        userMessage = "Access denied. You do not have permission for this resource.";
-    }
-    else if (/\b404\b/.test(detail) || detail.includes("Redash API error (404)")) {
-        userMessage = "The requested resource was not found. Please check the ID and try again.";
-    }
-    else if (detail.includes("Redash API error")) {
-        userMessage = "The Redash API returned an error. Please try again later.";
-    }
-    else if (detail.includes("fetch failed") || detail.includes("ECONNREFUSED") || detail.includes("ENOTFOUND")) {
-        userMessage = "Unable to connect to the Redash server. Please check REDASH_URL and network connectivity.";
-    }
-    else {
-        userMessage = "An unexpected error occurred. Please try again or check the server logs.";
-    }
-    return {
-        content: [{ type: "text", text: userMessage }],
-        isError: true,
-    };
-}