find_dq_rules

package

v0.0.58 Latest Latest Go to latest Published: Sep 14, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/collibra/chip

Links

Open Source Insights

Documentation ¶

Overview ¶

Package find_dq_rules implements the find_dq_rules MCP tool: it searches existing data quality rules (monitors) across jobs, primarily to detect rules already present on a target column before creating a new one.

Index ¶

func NewTool(collibraClient *http.Client) *chip.Tool[Input, Output]
type Input
type Output
type OutputStatus
type Rule

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewTool ¶

func NewTool(collibraClient *http.Client) *chip.Tool[Input, Output]

NewTool returns the registered tool.

Types ¶

type Input ¶

type Input struct {
	JobName      string `` /* 159-byte string literal not displayed */
	ColumnName   string `` /* 160-byte string literal not displayed */
	NameContains string `` /* 129-byte string literal not displayed */
	Offset       int    `json:"offset,omitempty" jsonschema:"Optional. Pagination offset (min 0). Defaults to 0."`
	Limit        int    `json:"limit,omitempty" jsonschema:"Optional. Max rules to return (1-100). Defaults to 25."`
}

Input is the tool's typed input. At least one filter should be provided; for duplicate detection, set jobName and columnName.

type Output ¶

type Output struct {
	Status  OutputStatus `` /* 128-byte string literal not displayed */
	Message string       `json:"message" jsonschema:"Human-readable summary."`
	Rules   []Rule       `json:"rules,omitempty" jsonschema:"Matching rules."`
	Total   int64        `json:"total" jsonschema:"Total number of matching rules (for pagination)."`
}

Output is the typed response.

type OutputStatus ¶

type OutputStatus string

OutputStatus is the overall outcome of a find_dq_rules call.

const (
	// StatusSuccess means the search ran.
	StatusSuccess OutputStatus = "success"
	// StatusValidationError means the inputs failed validation before any read.
	StatusValidationError OutputStatus = "validation_error"
	// StatusError means the search failed due to a downstream DQ error.
	StatusError OutputStatus = "error"
)

type Rule ¶

type Rule struct {
	MonitorName   string   `json:"monitorName"`
	JobName       string   `json:"jobName"`
	ColumnName    string   `json:"columnName,omitempty"`
	MonitorType   string   `json:"monitorType,omitempty"`
	MonitorStatus string   `json:"monitorStatus,omitempty"`
	Dimensions    []string `json:"dimensions,omitempty"`
	RuleQuery     string   `json:"ruleQuery,omitempty"`
	FilterQuery   string   `json:"filterQuery,omitempty"`
}

Rule is one matching rule (monitor).

Source Files ¶

View all Source files

tool.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL