search_catalog_columns

package

v0.0.49 Latest Latest Go to latest Published: Aug 12, 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 search_catalog_columns implements the search_catalog_columns MCP tool: it finds catalog Column assets by metadata the public REST search cannot filter on (attribute values, assigned roles, relations to other assets), via the DGC Knowledge Graph GraphQL API. Multiple filters are combined with AND.

Index ¶

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

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 ColumnResult ¶

type ColumnResult struct {
	ID          string `json:"id" jsonschema:"Column asset UUID."`
	FullName    string `json:"fullName" jsonschema:"Fully-qualified column name."`
	DisplayName string `json:"displayName,omitempty" jsonschema:"Column display name."`
	Domain      string `json:"domain,omitempty" jsonschema:"The column's domain."`
}

ColumnResult is one matching column.

type Input ¶

type Input struct {
	Domain          string `json:"domain,omitempty" jsonschema:"Optional. Exact domain name the column lives in."`
	Community       string `json:"community,omitempty" jsonschema:"Optional. Exact community name (the column's domain's parent)."`
	Description     string `json:"description,omitempty" jsonschema:"Optional. Substring to match in the column's Description attribute."`
	DataType        string `json:"dataType,omitempty" jsonschema:"Optional. Substring to match in the column's Data Type attribute."`
	DataStewardRole string `` /* 191-byte string literal not displayed */
	BusinessTerm    string `json:"businessTerm,omitempty" jsonschema:"Optional. Exact display name of a Business Term the column represents."`
	BusinessRule    string `json:"businessRule,omitempty" jsonschema:"Optional. Exact display name of a Business Rule that governs the column."`
	DataElement     string `` /* 128-byte string literal not displayed */
	DataAttribute   string `json:"dataAttribute,omitempty" jsonschema:"Optional. Exact display name of a Data Attribute that represents the column."`
	Limit           int    `json:"limit,omitempty" jsonschema:"Optional. Max columns to return. Defaults to 25."`
	Offset          int    `json:"offset,omitempty" jsonschema:"Optional. Pagination offset (min 0). Defaults to 0."`
}

Input is the tool's typed input. All filters are optional but at least one must be set; they are combined with AND. The search is always scoped to Column assets.

type Output ¶

type Output struct {
	Status  OutputStatus   `` /* 157-byte string literal not displayed */
	Message string         `json:"message" jsonschema:"Human-readable summary."`
	Columns []ColumnResult `json:"columns,omitempty" jsonschema:"Matching columns."`
	Count   int            `json:"count" jsonschema:"Number of columns returned."`
}

Output is the typed response.

type OutputStatus ¶

type OutputStatus string

OutputStatus is the overall outcome of a search_catalog_columns call.

const (
	// StatusSuccess means the search ran.
	StatusSuccess OutputStatus = "success"
	// StatusValidationError means the inputs failed validation before any call.
	StatusValidationError OutputStatus = "validation_error"
	// StatusError means the search failed (e.g. KG endpoint unavailable).
	StatusError OutputStatus = "error"
)

Source Files ¶

View all Source files

tool.go

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