Icedq Tools

io.github.icedq-tools由 GitHub 账号 icedq-tools 发布v2.0.3更新于 Oct 24, 2026

MCP Server for iceDQ Data Reliability Platform

概览

AI 生成的概览

将 AI 助手连接到 iceDQ 实例,用于浏览数据源、剖析数据,并创建、运行和监控数据质量规则。

可以做什么
该本地服务器提供 49 个面向 iceDQ 数据可靠性平台的工具。助手可以浏览工作区、连接、数据库、文件和 REST API;获取样本数据并剖析空值、模式和类型;创建校验、重复、校验和、下推和核对规则。它还能把规则串联成工作流、设置调度、管理参数和 Groovy/Java 自定义函数、按需执行规则,并查看执行历史和异常报告。
适用场景
适用于已经使用 iceDQ 的团队,希望以对话方式编写和运行数据质量检查,而不必操作 iceDQ 界面。适合数据工程师进行数据剖析、迁移认证、跨源核对,或日常的规则执行与报告。
运行要求
需要本地 Node.js 20+ 运行环境(npx)或打包的 Claude Desktop 扩展,以及 iceDQ v7.5.0+ 账户。必需的环境变量:ICEDQ_BASE_URL、ICEDQ_REALM、ICEDQ_CLIENT_ID、ICEDQ_ORG_ID 和 AUTH_TYPE。用户名密码模式还需 ICEDQ_USERNAME、ICEDQ_PASSWORD 和 ICEDQ_CLIENT_SECRET;访问令牌模式需要 TOKENS_PATH。需通过 HTTPS 访问你的 iceDQ 实例。
安装前请注意
用户名密码模式会把 ICEDQ_PASSWORD 和 ICEDQ_CLIENT_SECRET 写入客户端配置文件,使用设备流或令牌文件可避免。通过工具创建的规则会立即发布并可执行;服务器还能执行规则、触发调度、移动规则,以及创建或更新参数和自定义函数,这些都会改动 iceDQ 实例中的数据。来自数据源的样本数据和异常报告会经过助手。将 VERIFY_SSL 设为 false 会削弱 TLS 保护。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Icedq Tools,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

[iceDQ Logo]

iceDQ MCP Server

Connect your AI assistant to the iceDQ Data Reliability Platform

Website  •  Documentation  •  Support  •  Privacy Policy

[Version] [License] [Node]


How It Works?

The iceDQ MCP Server connects Claude Desktop, VS Code, Cursor, and Claude Code to your iceDQ Data Reliability Platform instance, letting you manage data quality using natural language. Ask your AI assistant to explore databases, files, or REST APIs; profile data; and create Validation, Duplicate, Checksum, Pushdown, and Reconciliation rules (including API Validation and API Recon) — then execute, monitor, and analyze results, all through conversation.

Rules created through MCP tools are published immediately and ready to execute. The server also bundles eight agent skills (skills/) that guide authoring, comparison, API testing, runs, and schedules. Parameter names and schemas are listed in TOOLS.md.

49 tools covering the full data quality lifecycle:

CapabilityWhat you can do
Data ExplorationBrowse workspaces, connections, databases, schemas, tables, columns, files, and REST APIs
Data ProfilingFetch real sample data and analyze quality metrics (nulls, patterns, types)
AI SuggestionsGet intelligent check recommendations based on your data profile
Validation RulesRow-level NotNull, Format, ValidValues, Length, Date, and Custom Groovy checks on DB, files, or APIs
Duplicate DetectionIdentify duplicates on business keys, composite keys, or conditional criteria
Pushdown RulesSQL-driven aggregate validation (GROUP BY, JOINs, referential integrity)
Checksum RulesCross-source comparison (row counts, sums) between two different connections
ReconciliationRow-level matching across databases, files, and APIs, with AI-powered join-key mapping
WorkflowsChain multiple rules into sequential execution workflows
SchedulesAutomate rule execution with one-time, daily, or weekly schedules
Custom FunctionsCreate and update Java/Groovy UDFs (Evaluator or Processor type)
Data Warehouse QueriesRun structured, schema-validated queries against iceDQ's execution history datasets
Execution & MonitoringRun rules on demand, track status, and view exception reports
OrganizationManage folders, move rules in batch, create reusable parameters

System Requirements

RequirementDetails
Operating SystemWindows 10+, macOS 10.15+, or Linux (see note below)
AI ClientOne of: Claude Desktop, VS Code, or Cursor (latest version)
Node.js20.0.0+ (required for npx-based setup; the Claude Desktop extension bundles its own runtime)
iceDQv7.5.0+ with a valid user account

Linux users: Install via the npx method (works in VS Code and Cursor). The packaged Claude Desktop extension (.mcpb) is currently macOS and Windows only because Claude Desktop itself does not ship a Linux build.


Quick Start

Step 1 — Get Your iceDQ Credentials

You need six values from your iceDQ instance before you can configure the MCP server:

  • iceDQ Base URL
  • Realm (default iam.icedq)
  • Client ID and Client Secret (created in iceDQ → Administration → Security → Client Credentials)
  • Your iceDQ username and password
  • Organization ID (read from any rule's metadata)

For step-by-step instructions with screenshots, see the Credentials Guide.

Step 2 — Install via npm

The iceDQ MCP Server is published on npm as @icedq/mcp-server. Most AI clients can launch it automatically with npx — no manual download or build step required.

Add the following to your AI client's MCP configuration:

json
{  "mcpServers": {    "icedq": {      "command": "npx",      "args": ["-y", "@icedq/mcp-server"],      "env": {        "ICEDQ_BASE_URL": "https://app.icedq.net",        "ICEDQ_REALM": "iam.icedq",        "ICEDQ_CLIENT_ID": "<your-client-id>",        "ICEDQ_CLIENT_SECRET": "<your-client-secret>",        "AUTH_TYPE": "username_password",        "ICEDQ_USERNAME": "<your-username>",        "ICEDQ_PASSWORD": "<your-password>",        "ICEDQ_ORG_ID": "<your-org-id>",        "NODE_OPTIONS": "--use-system-ca"      }    }  }}
Configuration Reference
VariableRequiredDescription
ICEDQ_BASE_URLYesBase URL of your iceDQ instance (e.g. https://app.icedq.net)
ICEDQ_REALMYesAuthentication realm (default iam.icedq)
ICEDQ_CLIENT_IDYesOAuth client ID for API authentication
AUTH_TYPEYesusername_password, access_token, or device_flow
ICEDQ_ORG_IDYesYour iceDQ organization ID
ICEDQ_CLIENT_SECRETFor username_passwordOAuth client secret
ICEDQ_USERNAMEFor username_passwordYour iceDQ username
ICEDQ_PASSWORDFor username_passwordYour iceDQ password
TOKENS_PATHFor access_tokenPath to a token JSON file with accessToken and refreshToken
REMEMBER_MEOptional, for device_flowDefaults to remembering the cached session. Set to false to wipe stored tokens and force a fresh browser login
VERIFY_SSLOptionalDefaults to true. Set to false only for self-signed certificates
REQUEST_TIMEOUTOptionalAPI request timeout in seconds (default 30)
DEBUGOptionalSet to true for verbose logging
LOG_LEVELOptionalerror, warn, info, or debug (default info)
NODE_OPTIONSOptionalSet to --use-system-ca so Node trusts your OS certificate store (needed if your iceDQ instance uses a corporate/self-signed CA)

Claude Desktop users can install the packaged extension instead of editing JSON — follow the setup guide below.

Alternative: Device Flow Authentication (no password required)

Instead of supplying a username and password, you can authenticate via Device Flow (RFC 8628) — the server opens a browser login page for you, and tokens are cached securely in your OS keychain (Windows Credential Manager, macOS Keychain, or Linux libsecret) so you only log in once. This is the recommended option for SSO/MFA-enabled accounts or shared machines where you don't want credentials stored in the MCP config.

json
{  "mcpServers": {    "icedq": {      "command": "npx",      "args": ["-y", "@icedq/mcp-server"],      "env": {        "ICEDQ_BASE_URL": "https://app.icedq.net",        "ICEDQ_REALM": "iam.icedq",        "ICEDQ_CLIENT_ID": "<your-client-id>",        "AUTH_TYPE": "device_flow",        "ICEDQ_ORG_ID": "<your-org-id>",        "NODE_OPTIONS": "--use-system-ca"      }    }  }}

On first run, the server prints a verification URL and code to the console and opens your browser automatically. Once you log in, tokens are cached (OS keychain, falling back to a token file) and silently refreshed on subsequent runs — no need to re-authenticate. Set REMEMBER_ME=false to skip the cache and force a fresh login every time. See the Device Flow internals guide for details.

Alternative: Access Token Authentication (pre-issued tokens)

If you already have an OAuth access/refresh token pair (e.g. issued by your own automation or a prior login), point the server at a token JSON file instead of supplying credentials directly:

json
{  "mcpServers": {    "icedq": {      "command": "npx",      "args": ["-y", "@icedq/mcp-server"],      "env": {        "ICEDQ_BASE_URL": "https://app.icedq.net",        "ICEDQ_REALM": "iam.icedq",        "ICEDQ_CLIENT_ID": "<your-client-id>",        "AUTH_TYPE": "access_token",        "TOKENS_PATH": "/path/to/tokens.json",        "ICEDQ_ORG_ID": "<your-org-id>",        "NODE_OPTIONS": "--use-system-ca"      }    }  }}

TOKENS_PATH must point to a JSON file shaped like:

json
{  "accessToken": "<JWT access token>",  "refreshToken": "<JWT refresh token>"}

The server reads this file on startup, uses the access token until it expires, and automatically refreshes it (rewriting the file) using the refresh token — no browser or password prompt involved. This is the recommended option for headless automation, CI, or server-to-server integrations where interactive login isn't possible.

Setup Guides

Choose your AI client for a step-by-step walkthrough:

ClientGuide
Claude DesktopInstallation in Claude Desktop
VS Code + Copilot ChatVS Code Setup
VS Code + Claude CodeClaude Code Setup
CursorCursor Setup

For authentication configuration, see the Authentication Guide.


Usage Examples

1. Explore Your Data

Prompt: List my iceDQ workspaces and show the connections

Response:

Found 2 workspaces:

  • Production_DQ (Active)
  • Development_DQ (Active)

Production_DQ has 3 connections:

  • SQL_Server_Production (SqlServer) - ACTIVE
  • Snowflake_Warehouse (Snowflake) - ACTIVE
  • Azure_DataLake (AzureBlob) - ACTIVE

2. Profile Data Quality

Prompt: Fetch sample data from the Customers table and suggest quality checks

Response:

Fetched 10 rows from dbo.Customers. Profiling results:

Email: 33% null, valid email pattern in 60% of values FirstName: 1 empty value detected Status: 2 distinct values: Active, Inactive CreatedDate: Date pattern yyyy-MM-dd detected

Suggested checks:

  1. Email - NotNull (33% nulls detected)
  2. Email - Format: Email pattern
  3. FirstName - NotNull (empty values found)
  4. Status - ValidValues: Active, Inactive
  5. CreatedDate - Date format: yyyy-MM-dd

3. Create a Validation Rule

Prompt: Create a validation rule called Customer_Quality_Checks with those suggested checks

Response:

Rule created successfully! Rule ID: rule-12345678-abcd-ef01-2345-678901234567 Name: Customer_Quality_Checks Checks: 5 checks configured Status: Published (ready to execute)

4. Detect Duplicates

Prompt: Check for duplicate emails in the Customers table

Response:

Duplicate detection rule created! Rule ID: rule-aabbccdd-1122-3344-5566-778899001122 Name: Customer_Email_Duplicates Columns: Email Status: Published (ready to execute)

5. Compare Data Across Sources

Prompt: Compare row counts between SQL Server Orders table and Snowflake FACT_ORDERS

Response:

Checksum rule created! Rule ID: rule-eeff0011-2233-4455-6677-889900aabbcc Name: Orders_vs_FACT_ORDERS_Checksum Source: SQL_Server_Production / dbo.Orders Target: Snowflake_Warehouse / DATAOPS_DW.FACT_ORDERS Check: SOURCE_COUNT - TARGET_COUNT == 0

6. Execute and Monitor

Prompt: Execute the Customer_Quality_Checks rule and show results

Response:

Execution completed! Status: Success Source rows: 1,000 Exceptions: 5 rows failed validation Exit code: 5

Breakdown:

  • Email_NotNull: 3 failures
  • Email_Format: 1 failure
  • FirstName_NotNull: 1 failure

7. Analyze Rule Execution History

Prompt: Analyze all rules executed last month and give me a summary of passed, failed, and errored rules

Response:

Execution Summary — Last 30 Days

Total rules executed: 24

Passed: 17 rules

  • Customer_Quality_Checks — 0 exceptions
  • Orders_NotNull_Check — 0 exceptions
  • Product_Format_Validation — 0 exceptions
  • ... 14 more

Failed: 5 rules (exceptions found)

  • Email_Duplicate_Check — 312 exceptions
  • Orders_vs_FACT_ORDERS_Checksum — count mismatch detected
  • Address_Format_Check — 87 exceptions
  • ... 2 more

Errored: 2 rules (execution did not complete)

  • Inventory_Recon_Rule — connection timeout
  • Sales_Pushdown_Check — query syntax error

Agent skills

The server ships eight skills under skills/ (also packaged into the Claude plugin). Each skill is self-contained; shared references are edited in skills/_shared/ and copied with sync.sh.

SkillUse when
icedq-suggest-checksYou want recommendations, coverage analysis, or a testing plan
icedq-author-rulesYou already know the checks (or another skill handed over a rule spec)
icedq-compare-datasetsMigration certification or ongoing reconciliation between two datasets
icedq-mapping-doc-rulesChecks should be derived from a mapping document
icedq-etl-code-rulesChecks should be derived from ETL/SQL/dbt code
icedq-api-testingThe source is a named REST API (validation or recon against a backend)
icedq-run-and-reportExecute existing rules/workflows and read exception reports
icedq-schedule-and-monitorAutomate existing rules and inspect schedule history

See skills/COMPATIBILITY.md for the skill ↔ server version policy, and evals/README.md for the evaluation suite.

Complete Tool Reference

Full names, parameters, and category counts are in Tools References (49 tools). Summary:

Discovery & Exploration (11 tools)

ToolDescription
List WorkspacesList all workspaces in your iceDQ instance
List ConnectionsList data source connections in a workspace
Test ConnectionTest connectivity for a data source connection
List FoldersList folders for organizing rules, workflows, schedules, and parameters
List RulesSearch and filter rules by folder, name, state, or type
List WorkflowsList all workflows in a workspace
List SchedulesList all schedules in a workspace
Get Database MetadataGet connection details and database capabilities
List Connection MetadataNavigate databases, schemas, tables, or columns for a connection
Get RuleGet full rule configuration, checks, and metadata
Get GuidanceGet step-by-step workflow guidance before starting a multi-step task

Data Analysis & Profiling (6 tools)

ToolDescription
Fetch Sample DataFetch real rows from a database table or custom SQL query
List FilesList files available in a flat-file connection (Azure Blob, S3, local)
Fetch File Sample DataFetch sample data from a file (CSV, Parquet, Excel, JSON, XML) and register its schema
Fetch API Sample DataFetch sample data from a REST API endpoint and register its schema
Profile DataAnalyze sample data for nulls, patterns, types, uniqueness
Suggest Quality ChecksAI-powered check recommendations from profiled data

Rule Creation (6 tools)

ToolDescription
Create Validation RuleRow-level validation with NotNull, Format, ValidValues, Length, Date, and Custom checks
Create Duplicate RuleDuplicate detection on single or composite columns
Create Pushdown RuleSQL-driven aggregate and cross-table validation
Create Checksum RuleCross-source numeric comparison (COUNT, SUM, AVG)
Analyze Recon MappingAI-powered join key and column mapping suggestions
Create Recon RuleRow-level cross-source reconciliation

Rule Management (3 tools)

ToolDescription
Update RuleAdd/remove checks, change source table or SQL
Move Rules or WorkflowsMove rules or workflows between folders (batch supported, async)
Check Task StatusMonitor async operations such as moves

Custom Functions (3 tools)

ToolDescription
Manage Custom FunctionCreate or update a Java/Groovy UDF (Evaluator or Processor type)
List Custom FunctionsList all UDFs in a workspace
Get Custom FunctionGet the full source code and metadata of a UDF

Workflows (2 tools)

ToolDescription
Create WorkflowChain multiple rules into a sequential workflow
Update Workflow RulesAdd or remove rules from an existing workflow

Schedules (3 tools)

ToolDescription
Create ScheduleSchedule automated rule/workflow execution
Modify ScheduleUpdate schedule timing, recurrence, or configuration
Add Rules/Workflows to ScheduleAdd additional rules/workflows to an existing schedule

Parameters (4 tools)

ToolDescription
List ParametersList and search parameters in a workspace
Get ParameterGet full details of a parameter, including key-value pairs
Create or Update ParameterCreate a new parameter or update an existing one
Parse CSV and Create ParameterImport a parameter's key-value pairs from a CSV file

Data Warehouse Queries (3 tools)

ToolDescription
Datawarehouse Query SchemaDiscover datasets, columns, metrics, and joins available for querying
Datawarehouse Query ExecutorExecute structured, schema-validated data warehouse queries
Validate and Explain Structured QueryDry-run a query and preview generated SQL before executing

Execution & Monitoring (7 tools)

ToolDescription
Execute Rules or WorkflowsExecute one or more rules or workflows on demand
Execute ScheduleTrigger a schedule on demand
Get Rule/Workflow Run HistoryView execution history for a rule or workflow
Get Workflow Run Status or ResultTrack progress or fetch detailed per-activity results of an execution
Get Scheduler Runs HistoryView execution history for a schedule
Get Checks Exception ReportView row-level failure details for a rule run
Get Exception Report URLGet the iceDQ UI URL to view the full exception report for a rule or workflow instance

Organization (1 tool)

ToolDescription
Create FolderCreate folders to organize rules, workflows, schedules, and parameters

Troubleshooting

IssueSolution
Organization ID requiredAdd your Organization ID in configuration (e.g. org-icedq)
SSL certificate verification failedClaude Desktop: uncheck Verify SSL. npx: set VERIFY_SSL to false (self-signed certs only). Prefer NODE_OPTIONS: --use-system-ca for corporate CAs
No workspaces returnedVerify credentials, check base URL, ensure user has workspace access
Sample data not returningCheck connection is ACTIVE, verify table name (case-sensitive), check permissions
Authentication failuresVerify client ID, client secret, username, and password are correct

Enable Debug Mode

For detailed troubleshooting, enable verbose logging:

  • Claude Desktop (extension): Settings → Extensions → iceDQ → Configure → Debug Mode: ON
  • npx / manual configuration: add "DEBUG": "true" to the env block of your MCP configuration

Claude Desktop extension log locations:

  • Windows: %APPDATA%\Claude\Logs\extensions\
  • macOS: ~/Library/Logs/Claude/extensions/

Security & Privacy

How Your Data is Protected

  • Credentials are provided through your AI client's configuration and sent only to your iceDQ instance — the Claude Desktop extension stores them in your operating system keychain
  • All communication uses HTTPS with OAuth 2.0 authentication
  • Data flows directly between your AI client and your iceDQ instance -- no third parties
  • No telemetry or tracking of any kind
  • No data persistence by the MCP server beyond the active session, except tokens you opt into (device_flow OS keychain / access_token TOKENS_PATH)
  • SSL verification is enabled by default

Privacy Policy

Data collection: None. The MCP server collects no usage data, telemetry, or analytics.

Usage & storage: All data flows directly between your AI client and your iceDQ instance. The MCP server holds credentials and API tokens in memory for the active session. In device_flow mode, tokens are cached in the OS keychain (with a local file fallback). In access_token mode, tokens are persisted to the TOKENS_PATH file you supply. Nothing is written anywhere else.

Third-party sharing: None. No data is transmitted to Anthropic, iceDQ, or any third party beyond your own iceDQ instance.

Data retention: The MCP server retains nothing after the session ends. Token files (if used) remain on your local machine under your full control and can be deleted at any time.

Contact: [email protected]

For full details, see: https://icedq.com/privacy-policy


Support

Need help? We're here for you.

ChannelContact
Email[email protected]
Documentationdocs.icedq.com
Websiteicedq.com

iceDQ Data Quality Platform
End-to-end data reliability, powered by AI

icedq.com

来源:README.md,提交 3ce15ae

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

3
  1. v2.0.3最新Sep 17, 2026
  2. v2.0.2Sep 17, 2026
  3. v2.0.0Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分