get_dq_rule_template

package

v0.0.46 Latest Latest Go to latest Published: Aug 4, 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 get_dq_rule_template implements the get_dq_rule_template MCP tool: it reads a single data quality rule template by name.

Index ¶

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

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 {
	RuleTemplateName string `json:"ruleTemplateName" jsonschema:"Required. Name of the rule template (from list_data_quality_rule_templates)."`
}

Input is the tool's typed input.

type Output ¶

type Output struct {
	Status   OutputStatus `` /* 136-byte string literal not displayed */
	Message  string       `json:"message" jsonschema:"Human-readable summary."`
	Template *Template    `json:"template,omitempty" jsonschema:"The template definition, on success."`
}

Output is the typed response.

type OutputStatus ¶

type OutputStatus string

OutputStatus is the overall outcome of a get_dq_rule_template call.

const (
	// StatusSuccess means the template was found and returned.
	StatusSuccess OutputStatus = "success"
	// StatusValidationError means the inputs failed validation before any read.
	StatusValidationError OutputStatus = "validation_error"
	// StatusError means the template could not be read due to a downstream error.
	StatusError OutputStatus = "error"
)

type Template ¶

type Template struct {
	ID                string   `json:"id"`
	Name              string   `json:"ruleTemplateName"`
	Description       string   `json:"description,omitempty"`
	SQL               string   `json:"sql,omitempty"`
	Dialect           string   `json:"dialect,omitempty"`
	Dimensions        []string `json:"dimensions,omitempty"`
	Tolerance         *int     `json:"tolerance,omitempty"`
	IsSystem          bool     `json:"isSystem"`
	DeployedRuleCount int64    `json:"deployedRuleCount"`
}

Template is the returned template definition.

Source Files ¶

View all Source files

tool.go

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