redash-mcp 3.1.4 → 3.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.dockerignore +17 -0
- package/Dockerfile +29 -0
- package/README.ja.md +21 -2
- package/README.ko.md +22 -3
- package/README.md +20 -1
- package/manifest.json +1 -1
- package/package.json +14 -3
- package/smithery.yaml +46 -0
package/.dockerignore
ADDED
package/Dockerfile
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Dockerfile for Glama (and other container-based MCP hosts) introspection.
|
|
2
|
+
#
|
|
3
|
+
# redash-mcp is a local stdio MCP server. This image lets a host start the
|
|
4
|
+
# server and answer introspection (tools/list) requests without real Redash
|
|
5
|
+
# credentials — the placeholder env values below only satisfy the startup
|
|
6
|
+
# guard; actual tool calls require real REDASH_URL / REDASH_API_KEY at runtime.
|
|
7
|
+
|
|
8
|
+
FROM node:20-slim AS build
|
|
9
|
+
WORKDIR /app
|
|
10
|
+
COPY package.json package-lock.json ./
|
|
11
|
+
RUN npm ci
|
|
12
|
+
COPY tsconfig.json ./
|
|
13
|
+
COPY scripts ./scripts
|
|
14
|
+
COPY src ./src
|
|
15
|
+
RUN npm run build
|
|
16
|
+
|
|
17
|
+
FROM node:20-slim
|
|
18
|
+
WORKDIR /app
|
|
19
|
+
ENV NODE_ENV=production
|
|
20
|
+
COPY package.json package-lock.json ./
|
|
21
|
+
RUN npm ci --omit=dev && npm cache clean --force
|
|
22
|
+
COPY --from=build /app/dist ./dist
|
|
23
|
+
|
|
24
|
+
# Placeholder credentials so the server boots and answers introspection.
|
|
25
|
+
# Override these with real values to actually use the server.
|
|
26
|
+
ENV REDASH_URL=http://localhost \
|
|
27
|
+
REDASH_API_KEY=placeholder
|
|
28
|
+
|
|
29
|
+
ENTRYPOINT ["node", "dist/index.js"]
|
package/README.ja.md
CHANGED
|
@@ -3,14 +3,27 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/redash-mcp)
|
|
4
4
|
[](https://www.npmjs.com/package/redash-mcp)
|
|
5
5
|
[](https://nodejs.org)
|
|
6
|
+
[](https://smithery.ai/servers/dev-seob717/redash-mcp)
|
|
6
7
|
|
|
7
8
|
[English](README.md) | [한국어](README.ko.md) | 日本語
|
|
8
9
|
|
|
9
10
|
> [Redash](https://redash.io) を Claude AI に接続する MCP サーバー — 自然言語でデータを照会し、SQL を実行し、ダッシュボードを管理します。
|
|
10
11
|
|
|
11
|
-
[機能](#機能) · [インストール](#インストール) · [環境変数](#環境変数) · [使用例](#使用例) · [Privacy](#privacy-policy)
|
|
12
|
+
[なぜ redash-mcp か](#なぜ-redash-mcp-か) · [機能](#機能) · [インストール](#インストール) · [環境変数](#環境変数) · [使用例](#使用例) · [Privacy](#privacy-policy)
|
|
12
13
|
|
|
13
|
-
> 英語版 README との最終同期: 2026-
|
|
14
|
+
> 英語版 README との最終同期: 2026-06-09
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## なぜ redash-mcp か?
|
|
19
|
+
|
|
20
|
+
Redash MCP サーバーは複数あります。このサーバーは、LLM に **本番(production)データ** を安全に扱わせることに重点を置いています:
|
|
21
|
+
|
|
22
|
+
- **🛡️ SQL セーフティガード** — `DROP`/`TRUNCATE`/`ALTER`、`WHERE` なしの `DELETE`/`UPDATE` をブロック。`strict`/`warn`/`off` モード、PII 検出、自動 `LIMIT` まで備え、実際の Redash を安心して Claude に任せられます。
|
|
23
|
+
- **🧠 BIRD スマートクエリ** — 質問を解析して適切なテーブルを自動選択し、SQL 生成をガイドします([BIRD text-to-SQL](https://bird-bench.github.io/) 手法ベース)。テーブル選択用の Claude Haiku フォールバックもオプションで利用できます。
|
|
24
|
+
- **⚡ ワンコマンドでセットアップ** — `npx redash-mcp setup` が Claude Desktop / Claude Code の設定を代わりに行います。JSON を手で編集する必要はありません。
|
|
25
|
+
- **🔒 完全ローカル** — Redash インスタンスと直接通信し、API キーとクエリ結果が端末から外に出ることはありません。
|
|
26
|
+
- **📊 エンドツーエンド** — 照会・保存・複製、ダッシュボード、ウィジェット、アラートまで、6 カテゴリ・20 以上のツール。
|
|
14
27
|
|
|
15
28
|
---
|
|
16
29
|
|
|
@@ -23,6 +36,12 @@
|
|
|
23
36
|
| データソース | `list_data_sources` | 接続されたデータソースの一覧を取得 |
|
|
24
37
|
| スキーマ | `list_tables` | テーブル一覧を取得(キーワード検索対応) |
|
|
25
38
|
| スキーマ | `get_table_columns` | テーブルのカラム名と型を取得 |
|
|
39
|
+
| スマートクエリ | `smart_query` | 質問を解析 → テーブルを自動選択 → SQL 生成をガイド (BIRD) |
|
|
40
|
+
| スマートクエリ | `get_bird_config` | 現在有効な BIRD スマートクエリ設定を取得 |
|
|
41
|
+
| スマートクエリ | `evaluate_queries` | 生成された SQL を期待結果と比較評価 |
|
|
42
|
+
| スマートクエリ | `submit_query_feedback` | テーブル選択を改善するためのフィードバックを記録 |
|
|
43
|
+
| スマートクエリ | `manage_few_shot_examples` | BIRD few-shot 例の追加/一覧 |
|
|
44
|
+
| スマートクエリ | `manage_keyword_map` | キーワード→テーブルのマッピングの追加/一覧 |
|
|
26
45
|
| クエリ実行 | `run_query` | SQL を実行して結果を返す |
|
|
27
46
|
| 保存クエリ | `list_queries` | 保存済みクエリの一覧を取得 |
|
|
28
47
|
| 保存クエリ | `get_query` | クエリの詳細(SQL、可視化)を取得 |
|
package/README.ko.md
CHANGED
|
@@ -3,14 +3,27 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/redash-mcp)
|
|
4
4
|
[](https://www.npmjs.com/package/redash-mcp)
|
|
5
5
|
[](https://nodejs.org)
|
|
6
|
+
[](https://smithery.ai/servers/dev-seob717/redash-mcp)
|
|
6
7
|
|
|
7
8
|
[English](README.md) | 한국어 | [日本語](README.ja.md)
|
|
8
9
|
|
|
9
|
-
> [Redash](https://redash.io)를 Claude AI에 연결하는 MCP 서버 — 자연어로 데이터를
|
|
10
|
+
> [Redash](https://redash.io)를 Claude AI에 연결하는 MCP 서버 — 자연어로 데이터를 조회하고, SQL을 실행하고, 대시보드를 관리하세요.
|
|
10
11
|
|
|
11
|
-
[기능](#기능) · [설치](#설치) · [환경 변수](#환경-변수) · [사용 예시](#사용-예시) · [Privacy](#privacy-policy)
|
|
12
|
+
[왜 redash-mcp인가](#왜-redash-mcp인가) · [기능](#기능) · [설치](#설치) · [환경 변수](#환경-변수) · [사용 예시](#사용-예시) · [Privacy](#privacy-policy)
|
|
12
13
|
|
|
13
|
-
> 영문 README와 마지막 동기화: 2026-
|
|
14
|
+
> 영문 README와 마지막 동기화: 2026-06-09
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 왜 redash-mcp인가?
|
|
19
|
+
|
|
20
|
+
Redash MCP 서버는 여러 개 있습니다. 이 서버는 LLM이 **운영(production) 데이터**를 안전하게 다루도록 만드는 데 초점을 맞췄습니다:
|
|
21
|
+
|
|
22
|
+
- **🛡️ SQL 안전 가드** — `DROP`/`TRUNCATE`/`ALTER`, `WHERE` 없는 `DELETE`/`UPDATE`를 차단합니다. `strict`/`warn`/`off` 모드, PII 감지, 자동 `LIMIT`까지 지원해 실제 Redash를 Claude에 안심하고 맡길 수 있습니다.
|
|
23
|
+
- **🧠 BIRD 스마트 쿼리** — 질문을 분석해 적절한 테이블을 자동 선택하고 SQL 생성을 가이드합니다([BIRD text-to-SQL](https://bird-bench.github.io/) 방법론 기반). 테이블 선택용 Claude Haiku 폴백도 선택적으로 지원합니다.
|
|
24
|
+
- **⚡ 한 번의 명령으로 설치** — `npx redash-mcp setup`이 Claude Desktop / Claude Code 설정을 대신 잡아줍니다. JSON을 직접 손댈 필요가 없습니다.
|
|
25
|
+
- **🔒 완전 로컬** — Redash 인스턴스와 직접 통신하며, API 키와 쿼리 결과가 기기를 벗어나지 않습니다.
|
|
26
|
+
- **📊 처음부터 끝까지** — 조회·저장·복제, 대시보드, 위젯, 알림까지 6개 카테고리에 걸친 20개 이상의 툴.
|
|
14
27
|
|
|
15
28
|
---
|
|
16
29
|
|
|
@@ -23,6 +36,12 @@
|
|
|
23
36
|
| 데이터소스 | `list_data_sources` | 연결된 데이터소스 목록 조회 |
|
|
24
37
|
| 스키마 | `list_tables` | 테이블 목록 조회 (키워드 검색 가능) |
|
|
25
38
|
| 스키마 | `get_table_columns` | 테이블 컬럼명 및 타입 조회 |
|
|
39
|
+
| 스마트 쿼리 | `smart_query` | 질문 분석 → 테이블 자동 선택 → SQL 생성 가이드 (BIRD) |
|
|
40
|
+
| 스마트 쿼리 | `get_bird_config` | 현재 적용 중인 BIRD 스마트 쿼리 설정 조회 |
|
|
41
|
+
| 스마트 쿼리 | `evaluate_queries` | 생성된 SQL을 기대 결과와 비교 평가 |
|
|
42
|
+
| 스마트 쿼리 | `submit_query_feedback` | 테이블 선택 개선을 위한 피드백 기록 |
|
|
43
|
+
| 스마트 쿼리 | `manage_few_shot_examples` | BIRD few-shot 예제 추가/조회 |
|
|
44
|
+
| 스마트 쿼리 | `manage_keyword_map` | 키워드→테이블 매핑 추가/조회 |
|
|
26
45
|
| 쿼리 실행 | `run_query` | SQL 직접 실행 후 결과 반환 |
|
|
27
46
|
| 저장 쿼리 | `list_queries` | 저장된 쿼리 목록 조회 |
|
|
28
47
|
| 저장 쿼리 | `get_query` | 쿼리 상세 정보 (SQL, 시각화 등) 조회 |
|
package/README.md
CHANGED
|
@@ -3,12 +3,25 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/redash-mcp)
|
|
4
4
|
[](https://www.npmjs.com/package/redash-mcp)
|
|
5
5
|
[](https://nodejs.org)
|
|
6
|
+
[](https://smithery.ai/servers/dev-seob717/redash-mcp)
|
|
6
7
|
|
|
7
8
|
English | [한국어](README.ko.md) | [日本語](README.ja.md)
|
|
8
9
|
|
|
9
10
|
> MCP server that connects [Redash](https://redash.io) to Claude AI — query data, manage dashboards, and run SQL with natural language.
|
|
10
11
|
|
|
11
|
-
[Features](#features) · [Install](#installation) · [Env](#environment-variables) · [Examples](#usage-examples) · [Privacy](#privacy-policy)
|
|
12
|
+
[Why](#why-redash-mcp) · [Features](#features) · [Install](#installation) · [Env](#environment-variables) · [Examples](#usage-examples) · [Privacy](#privacy-policy)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Why redash-mcp?
|
|
17
|
+
|
|
18
|
+
There are several Redash MCP servers. This one is built for letting an LLM touch **production** data safely:
|
|
19
|
+
|
|
20
|
+
- **🛡️ SQL Safety Guard** — blocks `DROP`/`TRUNCATE`/`ALTER` and `DELETE`/`UPDATE` without `WHERE`; `strict`/`warn`/`off` modes, PII detection, and auto-`LIMIT`. Hand Claude your real Redash without flinching.
|
|
21
|
+
- **🧠 BIRD Smart Query** — analyzes the question, auto-selects the right tables, and guides SQL generation (based on the [BIRD text-to-SQL](https://bird-bench.github.io/) methodology). Optional Claude Haiku fallback for table selection.
|
|
22
|
+
- **⚡ One-command setup** — `npx redash-mcp setup` configures Claude Desktop / Claude Code for you. No hand-editing JSON.
|
|
23
|
+
- **🔒 Fully local** — talks directly to your Redash instance. API key and query results never leave your machine.
|
|
24
|
+
- **📊 End-to-end** — query, save, fork, dashboards, widgets, and alerts — 20+ tools across 6 categories.
|
|
12
25
|
|
|
13
26
|
---
|
|
14
27
|
|
|
@@ -21,6 +34,12 @@ English | [한국어](README.ko.md) | [日本語](README.ja.md)
|
|
|
21
34
|
| Data Sources | `list_data_sources` | List connected data sources |
|
|
22
35
|
| Schema | `list_tables` | List tables (supports keyword search) |
|
|
23
36
|
| Schema | `get_table_columns` | Get column names and types |
|
|
37
|
+
| Smart Query | `smart_query` | Analyze a question, auto-select tables, guide SQL generation (BIRD) |
|
|
38
|
+
| Smart Query | `get_bird_config` | Inspect the active BIRD smart-query configuration |
|
|
39
|
+
| Smart Query | `evaluate_queries` | Evaluate generated SQL against expected results |
|
|
40
|
+
| Smart Query | `submit_query_feedback` | Record feedback to improve future table selection |
|
|
41
|
+
| Smart Query | `manage_few_shot_examples` | Add/list BIRD few-shot examples |
|
|
42
|
+
| Smart Query | `manage_keyword_map` | Add/list keyword→table mappings |
|
|
24
43
|
| Query | `run_query` | Execute SQL and return results |
|
|
25
44
|
| Saved Queries | `list_queries` | List saved queries |
|
|
26
45
|
| Saved Queries | `get_query` | Get query details (SQL, visualizations) |
|
package/manifest.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"manifest_version": "0.3",
|
|
3
3
|
"name": "redash-mcp",
|
|
4
|
-
"version": "3.1.
|
|
4
|
+
"version": "3.1.5",
|
|
5
5
|
"description": "MCP server for Redash -- query data, manage dashboards, and run SQL with natural language. 24 tools including BIRD SQL methodology.",
|
|
6
6
|
"long_description": "Connects an MCP client to a Redash instance: list data sources, inspect schemas, run SQL, manage saved queries / dashboards / alerts, and use BIRD SQL helpers (smart_query, keyword maps, few-shot examples, feedback, evaluation). Built-in SQL safety guards flag PII access and expensive scans; safety mode can be tuned per install. **Third-party data flow:** if you also set ANTHROPIC_API_KEY in the shell environment, the BIRD smart_query tool may send table-name lists (never query results or row data) to the Anthropic API as a fallback for table selection. Leave ANTHROPIC_API_KEY unset to disable this entirely.",
|
|
7
7
|
"icon": "icon.png",
|
package/package.json
CHANGED
|
@@ -1,17 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "redash-mcp",
|
|
3
3
|
"mcpName": "io.github.seob717/redash-mcp",
|
|
4
|
-
"version": "3.1.
|
|
5
|
-
"description": "MCP server
|
|
4
|
+
"version": "3.1.5",
|
|
5
|
+
"description": "MCP server that connects Redash to Claude AI — query data, manage dashboards, and run SQL with natural language, with built-in SQL safety guards.",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "seob717",
|
|
8
8
|
"keywords": [
|
|
9
9
|
"mcp",
|
|
10
|
+
"mcp-server",
|
|
11
|
+
"model-context-protocol",
|
|
10
12
|
"redash",
|
|
13
|
+
"redash-api",
|
|
14
|
+
"claude",
|
|
15
|
+
"claude-ai",
|
|
16
|
+
"anthropic",
|
|
11
17
|
"sql",
|
|
18
|
+
"text-to-sql",
|
|
19
|
+
"llm",
|
|
20
|
+
"ai",
|
|
12
21
|
"bi",
|
|
22
|
+
"business-intelligence",
|
|
13
23
|
"dashboard",
|
|
14
|
-
"
|
|
24
|
+
"data-analytics",
|
|
25
|
+
"natural-language"
|
|
15
26
|
],
|
|
16
27
|
"engines": {
|
|
17
28
|
"node": ">=20"
|
package/smithery.yaml
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Smithery configuration for redash-mcp (https://smithery.ai/docs/build/project-config/smithery.yaml)
|
|
2
|
+
# redash-mcp is a local stdio MCP server distributed via npm. Smithery runs it
|
|
3
|
+
# with the user-supplied config below.
|
|
4
|
+
startCommand:
|
|
5
|
+
type: stdio
|
|
6
|
+
configSchema:
|
|
7
|
+
type: object
|
|
8
|
+
required:
|
|
9
|
+
- redashUrl
|
|
10
|
+
- redashApiKey
|
|
11
|
+
properties:
|
|
12
|
+
redashUrl:
|
|
13
|
+
type: string
|
|
14
|
+
description: "Your Redash instance URL (e.g. https://redash.example.com)"
|
|
15
|
+
redashApiKey:
|
|
16
|
+
type: string
|
|
17
|
+
description: "Your Redash user API key (Redash > Edit Profile > API Key)"
|
|
18
|
+
safetyMode:
|
|
19
|
+
type: string
|
|
20
|
+
enum: ["off", "warn", "strict"]
|
|
21
|
+
default: "warn"
|
|
22
|
+
description: "SQL safety level: 'strict' blocks risky queries, 'warn' returns warnings, 'off' disables guards."
|
|
23
|
+
autoLimit:
|
|
24
|
+
type: number
|
|
25
|
+
default: 0
|
|
26
|
+
description: "Auto-append LIMIT N to queries without one (0 = disabled)."
|
|
27
|
+
birdEnabled:
|
|
28
|
+
type: boolean
|
|
29
|
+
default: true
|
|
30
|
+
description: "Enable BIRD smart-query tools."
|
|
31
|
+
anthropicApiKey:
|
|
32
|
+
type: string
|
|
33
|
+
description: "Optional. Enables Claude Haiku fallback for table selection in smart_query."
|
|
34
|
+
commandFunction: |-
|
|
35
|
+
(config) => ({
|
|
36
|
+
command: 'npx',
|
|
37
|
+
args: ['-y', 'redash-mcp'],
|
|
38
|
+
env: {
|
|
39
|
+
REDASH_URL: config.redashUrl,
|
|
40
|
+
REDASH_API_KEY: config.redashApiKey,
|
|
41
|
+
REDASH_SAFETY_MODE: config.safetyMode ?? 'warn',
|
|
42
|
+
REDASH_AUTO_LIMIT: String(config.autoLimit ?? 0),
|
|
43
|
+
REDASH_BIRD_ENABLED: String(config.birdEnabled ?? true),
|
|
44
|
+
...(config.anthropicApiKey ? { ANTHROPIC_API_KEY: config.anthropicApiKey } : {})
|
|
45
|
+
}
|
|
46
|
+
})
|