tools

type AccessFilterMiddleware struct {
	// contains filtered or unexported fields
}

type AfterFunc func(ctx context.Context, tc *ToolContext, result *mcp.CallToolResult, err error) (*mcp.CallToolResult, error)

type AuditLoggerMiddleware struct {
	// contains filtered or unexported fields
}

type BeforeFunc func(ctx context.Context, tc *ToolContext) (context.Context, error)

type BrowseInput struct {
	//nolint:lll // struct tag cannot be split
	What   string `` /* 129-byte string literal not displayed */
	Filter string `json:"filter,omitempty" jsonschema_description:"Optional filter string (tags only)"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type BrowseOutput struct {
	Tags         []types.Tag         `json:"tags,omitempty"`
	Domains      []types.Domain      `json:"domains,omitempty"`
	DataProducts []types.DataProduct `json:"data_products,omitempty"`
}

type Config struct {
	// DefaultLimit is the default search result limit. Default: 10.
	DefaultLimit int

	// MaxLimit is the maximum allowed limit. Default: 100.
	MaxLimit int

	// MaxLineageDepth is the maximum lineage traversal depth. Default: 5.
	MaxLineageDepth int

	// WriteEnabled enables write operations (add/remove tags, glossary terms, etc.).
	// Default: false (read-only mode).
	WriteEnabled bool

	// Debug enables debug logging for toolkit operations.
	Debug bool

	// Logger is the logger for debug output. If nil and Debug is true, uses client.StdLogger.
	Logger client.Logger
}

type ConnectionInfoOutput struct {
	Name      string `json:"name"`
	URL       string `json:"url"`
	IsDefault bool   `json:"is_default"`
}

type CreateInput struct {
	//nolint:lll // struct tag cannot be split
	What string `` /* 305-byte string literal not displayed */

	// Common fields
	Name        string `json:"name,omitempty" jsonschema_description:"Name or title of the entity"`
	Description string `json:"description,omitempty" jsonschema_description:"Description or content of the entity"`

	// Glossary term fields
	ParentNode string `json:"parent_node,omitempty" jsonschema_description:"Parent glossary node URN (glossary_term only)"`

	// Data product fields
	DomainURN string `json:"domain_urn,omitempty" jsonschema_description:"Domain URN (data_product only, required)"`

	// Query fields
	Value       string   `json:"value,omitempty" jsonschema_description:"SQL statement (query only)"`
	Language    string   `json:"language,omitempty" jsonschema_description:"Query language, default SQL (query only)"`
	DatasetURNs []string `json:"dataset_urns,omitempty" jsonschema_description:"Associated dataset URNs (query, data_contract)"`

	// Incident fields
	EntityURNs   []string `json:"entity_urns,omitempty" jsonschema_description:"Affected entity URNs (incident only)"`
	IncidentType string   `json:"incident_type,omitempty" jsonschema_description:"Incident type: OPERATIONAL, CUSTOM, etc. (incident only)"`
	Priority     string   `json:"priority,omitempty" jsonschema_description:"Priority: LOW, MEDIUM, HIGH, CRITICAL (incident only)"`

	// Document fields
	Status        string   `json:"status,omitempty" jsonschema_description:"Publication status: PUBLISHED or UNPUBLISHED (document only)"`
	SubType       string   `json:"sub_type,omitempty" jsonschema_description:"Document sub-type (document only)"`
	RelatedAssets []string `json:"related_assets,omitempty" jsonschema_description:"Related asset URNs (document only)"`
	GlobalContext *bool    `json:"global_context,omitempty" jsonschema_description:"Show in global search (document only, default: true)"`

	// Structured property fields
	QualifiedName string   `json:"qualified_name,omitempty" jsonschema_description:"Fully qualified name (structured_property)"`
	ValueType     string   `json:"value_type,omitempty" jsonschema_description:"Value type: string, number, date, urn (structured_property)"`
	Cardinality   string   `json:"cardinality,omitempty" jsonschema_description:"SINGLE or MULTIPLE (structured_property only)"`
	EntityTypes   []string `json:"entity_types,omitempty" jsonschema_description:"Applicable entity types (structured_property only)"`

	// Data contract fields
	SchemaAssertions      []string `json:"schema_assertions,omitempty" jsonschema_description:"Schema assertion URNs"`
	FreshnessAssertions   []string `json:"freshness_assertions,omitempty" jsonschema_description:"Freshness assertion URNs"`
	DataQualityAssertions []string `json:"data_quality_assertions,omitempty" jsonschema_description:"Data quality assertion URNs"`

	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type CreateOutput struct {
	URN    string `json:"urn"`
	What   string `json:"what"`
	Action string `json:"action"`
}

type DataHubClient interface {
	// Search searches for entities.
	Search(ctx context.Context, query string, opts ...client.SearchOption) (*types.SearchResult, error)

	// GetEntity retrieves a single entity by URN.
	GetEntity(ctx context.Context, urn string) (*types.Entity, error)

	// GetSchema retrieves schema for a dataset.
	GetSchema(ctx context.Context, urn string) (*types.SchemaMetadata, error)

	// GetSchemas retrieves schemas for multiple datasets by URN.
	GetSchemas(ctx context.Context, urns []string) (map[string]*types.SchemaMetadata, error)

	// GetLineage retrieves lineage for an entity.
	GetLineage(ctx context.Context, urn string, opts ...client.LineageOption) (*types.LineageResult, error)

	// GetColumnLineage retrieves fine-grained column-level lineage for a dataset.
	GetColumnLineage(ctx context.Context, urn string) (*types.ColumnLineage, error)

	// GetQueries retrieves queries for a dataset.
	GetQueries(ctx context.Context, urn string) (*types.QueryList, error)

	// GetGlossaryTerm retrieves a glossary term.
	GetGlossaryTerm(ctx context.Context, urn string) (*types.GlossaryTerm, error)

	// ListTags lists all tags.
	ListTags(ctx context.Context, filter string) ([]types.Tag, error)

	// ListDomains lists all domains.
	ListDomains(ctx context.Context) ([]types.Domain, error)

	// ListDataProducts lists all data products.
	ListDataProducts(ctx context.Context) ([]types.DataProduct, error)

	// GetDataProduct retrieves a data product by URN.
	GetDataProduct(ctx context.Context, urn string) (*types.DataProduct, error)

	// Ping tests the connection.
	Ping(ctx context.Context) error

	// Close closes the client.
	Close() error

	// UpdateDescription sets the editable description for an entity.
	UpdateDescription(ctx context.Context, urn, description string) error

	// UpdateColumnDescription sets the description for a specific schema field.
	UpdateColumnDescription(ctx context.Context, urn, fieldPath, description string) error

	// AddTag adds a tag to an entity.
	AddTag(ctx context.Context, urn, tagURN string) error

	// RemoveTag removes a tag from an entity.
	RemoveTag(ctx context.Context, urn, tagURN string) error

	// AddGlossaryTerm adds a glossary term to an entity.
	AddGlossaryTerm(ctx context.Context, urn, termURN string) error

	// RemoveGlossaryTerm removes a glossary term from an entity.
	RemoveGlossaryTerm(ctx context.Context, urn, termURN string) error

	// AddLink adds a link to an entity.
	AddLink(ctx context.Context, urn, linkURL, description string) error

	// RemoveLink removes a link from an entity by URL.
	RemoveLink(ctx context.Context, urn, linkURL string) error

	// CreateQuery creates a new Query entity.
	CreateQuery(ctx context.Context, input client.CreateQueryInput) (*types.Query, error)

	// UpdateQuery updates an existing Query entity.
	UpdateQuery(ctx context.Context, input client.UpdateQueryInput) (*types.Query, error)

	// DeleteQuery deletes a Query entity.
	DeleteQuery(ctx context.Context, urn string) error

	// GetStructuredProperties retrieves structured property values assigned to an entity.
	GetStructuredProperties(ctx context.Context, urn string) ([]types.StructuredPropertyValue, error)

	// ListStructuredPropertyDefinitions retrieves all structured property definitions.
	ListStructuredPropertyDefinitions(ctx context.Context) ([]types.StructuredPropertyDefinition, error)

	// UpsertStructuredProperties sets or updates structured property values on an entity.
	UpsertStructuredProperties(ctx context.Context, urn string, properties []types.StructuredPropertyInput) error

	// RemoveStructuredProperties removes structured properties from an entity.
	RemoveStructuredProperties(ctx context.Context, urn string, propertyURNs []string) error

	// GetIncidents retrieves active incidents for an entity.
	GetIncidents(ctx context.Context, urn string) (*types.IncidentResult, error)

	// RaiseIncident creates a new incident on entities.
	RaiseIncident(ctx context.Context, input types.RaiseIncidentInput) (string, error)

	// UpdateIncidentStatus changes the state of an incident (ACTIVE or RESOLVED).
	UpdateIncidentStatus(ctx context.Context, incidentURN, state, message string) error

	// ResolveIncident marks an incident as resolved.
	ResolveIncident(ctx context.Context, incidentURN, message string) error

	// GetDataContract retrieves the data contract status for a dataset.
	GetDataContract(ctx context.Context, datasetURN string) (*types.DataContract, error)

	// SearchAcrossEntities searches across entity types with optional advanced filtering.
	SearchAcrossEntities(ctx context.Context, query string, opts ...client.SearchOption) (*types.SearchResult, error)

	// SemanticSearch performs natural language semantic search across entities.
	SemanticSearch(ctx context.Context, query string, opts ...client.SearchOption) (*types.SearchResult, error)

	// GetDocument retrieves a context document by URN.
	GetDocument(ctx context.Context, urn string) (*types.Document, error)

	// GetRelatedDocuments retrieves documents linked to an entity.
	GetRelatedDocuments(ctx context.Context, urn string) ([]types.Document, error)

	// GetContextDocuments retrieves context documents linked to an entity
	// as simplified ContextDocument values for downstream consumption.
	GetContextDocuments(ctx context.Context, urn string) ([]types.ContextDocument, error)

	// UpsertContextDocument creates or updates a context document on an entity.
	// If doc.ID is empty, creates a new document. If set, updates the existing one.
	UpsertContextDocument(ctx context.Context, entityURN string, doc types.ContextDocumentInput) (*types.ContextDocument, error)

	// DeleteContextDocument removes a context document by its ID.
	DeleteContextDocument(ctx context.Context, documentID string) error

	// CreateTag creates a new tag entity.
	CreateTag(ctx context.Context, name, description string) (string, error)

	// CreateDomain creates a new domain entity.
	CreateDomain(ctx context.Context, name, description string) (string, error)

	// CreateGlossaryTerm creates a new glossary term entity.
	CreateGlossaryTerm(ctx context.Context, name, description, parentNode string) (string, error)

	// CreateDataProduct creates a new data product entity.
	CreateDataProduct(ctx context.Context, name, description, domainURN string) (string, error)

	// CreateDocument creates a new context document entity.
	CreateDocument(ctx context.Context, input types.CreateDocumentInput) (string, error)

	// CreateApplication creates a new application entity.
	CreateApplication(ctx context.Context, name, description string) (string, error)

	// CreateStructuredProperty creates a new structured property definition.
	CreateStructuredProperty(ctx context.Context, input types.CreateStructuredPropertyInput) (string, error)

	// UpsertDataContract creates or updates a data contract for a dataset.
	UpsertDataContract(ctx context.Context, input types.UpsertDataContractInput) (string, error)

	// AddOwner adds an owner to an entity.
	AddOwner(ctx context.Context, urn, ownerURN, ownershipType string) error

	// RemoveOwner removes an owner from an entity.
	RemoveOwner(ctx context.Context, urn, ownerURN string) error

	// SetDomain assigns a domain to an entity.
	SetDomain(ctx context.Context, entityURN, domainURN string) error

	// UnsetDomain removes the domain from an entity.
	UnsetDomain(ctx context.Context, entityURN string) error

	// UpdateIncident updates an existing incident.
	UpdateIncident(ctx context.Context, urn string, input types.UpdateIncidentInput) error

	// UpdateStructuredProperty updates a structured property definition.
	UpdateStructuredProperty(ctx context.Context, urn string, input types.UpdateStructuredPropertyInput) error

	// UpdateDocumentContents updates the title and text of a document.
	UpdateDocumentContents(ctx context.Context, urn, title, text string) error

	// UpdateDocumentStatus updates the status of a document.
	UpdateDocumentStatus(ctx context.Context, urn, status string) error

	// UpdateDocumentRelatedEntities updates entities related to a document.
	UpdateDocumentRelatedEntities(ctx context.Context, urn string, entityURNs []string) error

	// UpdateDocumentSubType updates the sub-type of a document.
	UpdateDocumentSubType(ctx context.Context, urn, subType string) error

	// DeleteTag deletes a tag entity.
	DeleteTag(ctx context.Context, urn string) error

	// DeleteDomain deletes a domain entity.
	DeleteDomain(ctx context.Context, urn string) error

	// DeleteGlossaryEntity deletes a glossary term or node.
	DeleteGlossaryEntity(ctx context.Context, urn string) error

	// DeleteDataProduct deletes a data product entity.
	DeleteDataProduct(ctx context.Context, urn string) error

	// DeleteApplication deletes an application entity.
	DeleteApplication(ctx context.Context, urn string) error

	// DeleteDocument deletes a document entity.
	DeleteDocument(ctx context.Context, urn string) error

	// DeleteStructuredProperty deletes a structured property definition.
	DeleteStructuredProperty(ctx context.Context, urn string) error
}

type DeleteInput struct {
	//nolint:lll // struct tag cannot be split
	What string `` /* 261-byte string literal not displayed */

	URN        string `json:"urn" jsonschema_description:"URN of the entity to delete"`
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type DeleteOutput struct {
	URN    string `json:"urn"`
	What   string `json:"what"`
	Action string `json:"action"`
}

type GetDataProductInput struct {
	URN string `json:"urn" jsonschema_description:"The DataHub URN of the data product"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type GetEntityInput struct {
	URN string `json:"urn" jsonschema_description:"The DataHub URN of the entity"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type GetGlossaryTermInput struct {
	URN string `json:"urn" jsonschema_description:"The DataHub URN of the glossary term"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type GetLineageInput struct {
	URN string `json:"urn" jsonschema_description:"The DataHub URN of the entity"`
	//nolint:lll // struct tag cannot be split
	Level     string `` /* 130-byte string literal not displayed */
	Direction string `json:"direction,omitempty" jsonschema_description:"UPSTREAM or DOWNSTREAM (default: DOWNSTREAM, dataset level only)"`
	Depth     int    `json:"depth,omitempty" jsonschema_description:"Max depth of lineage traversal (default: 1, max: 5, dataset level only)"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type GetQueriesInput struct {
	URN string `json:"urn" jsonschema_description:"The DataHub URN of the dataset"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type GetSchemaInput struct {
	URN string `json:"urn" jsonschema_description:"The DataHub URN of the dataset"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type ListConnectionsInput struct{}

type ListConnectionsOutput struct {
	Connections []ConnectionInfoOutput `json:"connections"`
	Count       int                    `json:"count"`
}

type MetadataEnricherMiddleware struct {
	// contains filtered or unexported fields
}

type SearchFilterInput struct {
	// Field is the filter field name.
	Field string `json:"field" jsonschema_description:"Filter field name (see tool description for options)"`
	// Value is a convenience field for a single value. Use values for multiple.
	Value string `json:"value,omitempty" jsonschema_description:"Single filter value. Use 'values' for multiple."`
	// Values are the values to match against.
	Values []string `json:"values,omitempty" jsonschema_description:"Filter values to match against"`
	// Condition is the filter operator. Defaults to EQUAL if omitted.
	Condition string `json:"condition,omitempty" jsonschema_description:"Filter operator: CONTAIN, EQUAL (default), IN, EXISTS"`
	// Negated inverts the filter to exclude matches.
	Negated bool `json:"negated,omitempty" jsonschema_description:"If true, exclude entities matching this filter"`
}

type SearchInput struct {
	Query string `json:"query" jsonschema_description:"Search query string"`
	// EntityType: DATASET, DASHBOARD, DATA_FLOW, DATA_JOB, CONTAINER, etc.
	EntityType string `json:"entity_type,omitempty" jsonschema_description:"Entity type (single). Defaults to DATASET."`
	// Types allows searching across multiple entity types. Overrides entity_type.
	Types []string `json:"types,omitempty" jsonschema_description:"Entity types to search across. Overrides entity_type."`
	// Filters enable advanced field-level filtering via searchAcrossEntities.
	Filters []SearchFilterInput `json:"filters,omitempty" jsonschema_description:"Advanced field-level filters (AND'd together)."`
	Limit   int                 `json:"limit,omitempty" jsonschema_description:"Maximum number of results (default: 10, max: 100)"`
	Offset  int                 `json:"offset,omitempty" jsonschema_description:"Result offset for pagination"`
	// Mode selects the search strategy: "keyword" (default) or "semantic".
	// Semantic search uses vector embeddings for natural language queries.
	// Requires DataHub 1.4.x with OpenSearch 2.19.3+.
	Mode string `json:"mode,omitempty" jsonschema_description:"Search mode: keyword (default) or semantic"`
	// Connection is the named connection to use. Empty uses the default connection.
	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type ToolContext struct {
	// ToolName is the name of the tool being executed.
	ToolName ToolName

	// Input is the parsed input for the tool.
	Input any

	// StartTime is when the tool execution started.
	StartTime time.Time

	// Extra allows middleware to pass data between Before and After.
	Extra map[string]any
}

type ToolMiddleware interface {
	// Before is called before the tool handler executes.
	// Return a modified context or an error to abort execution.
	Before(ctx context.Context, tc *ToolContext) (context.Context, error)

	// After is called after the tool handler executes.
	// Can modify the result or handle errors.
	After(ctx context.Context, tc *ToolContext, result *mcp.CallToolResult, err error) (*mcp.CallToolResult, error)
}

type ToolName string

type ToolOption func(*toolConfig)

type Toolkit struct {
	// contains filtered or unexported fields
}

type ToolkitOption func(*Toolkit)

type URNResolverMiddleware struct {
	// contains filtered or unexported fields
}

type UpdateInput struct {
	//nolint:lll // struct tag cannot be split
	What string `` /* 553-byte string literal not displayed */

	//nolint:lll // struct tag cannot be split
	Action string `` /* 210-byte string literal not displayed */

	// Entity identification
	URN string `json:"urn" jsonschema_description:"URN of the entity to update"`

	// Common value field
	Value string `json:"value,omitempty" jsonschema_description:"New value (description text, status, sub_type, label, message, etc.)"`

	// Target URN for add/remove operations (tag, glossary_term, owner, domain)
	TargetURN string `json:"target_urn,omitempty" jsonschema_description:"Target URN (tag, glossary term, owner, or domain URN)"`

	// Link-specific fields
	URL string `json:"url,omitempty" jsonschema_description:"URL for link operations"`

	// Column description
	FieldPath string `json:"field_path,omitempty" jsonschema_description:"Schema field path (column_description only)"`

	// Owner-specific
	OwnershipType string `json:"ownership_type,omitempty" jsonschema_description:"Ownership type (owner add only, e.g. TECHNICAL_OWNER)"`

	// Structured properties on assets
	Properties   []types.StructuredPropertyInput `json:"properties,omitempty" jsonschema_description:"Structured property values to set"`
	PropertyURNs []string                        `json:"property_urns,omitempty" jsonschema_description:"Property URNs to remove"`

	// Query-specific
	Name        string   `json:"name,omitempty" jsonschema_description:"Updated name (query, incident, structured_property)"`
	Description string   `json:"description,omitempty" jsonschema_description:"Updated description"`
	Language    string   `json:"language,omitempty" jsonschema_description:"Query language (query only)"`
	DatasetURNs []string `json:"dataset_urns,omitempty" jsonschema_description:"Dataset URNs (query, data_contract)"`

	// Incident-specific
	IncidentType string `json:"incident_type,omitempty" jsonschema_description:"Incident type (incident only)"`
	Priority     string `json:"priority,omitempty" jsonschema_description:"Priority: LOW, MEDIUM, HIGH, CRITICAL (incident only)"`
	State        string `json:"state,omitempty" jsonschema_description:"Incident state: ACTIVE, RESOLVED (incident_status only)"`

	// Document-specific
	Title      string   `json:"title,omitempty" jsonschema_description:"Document title (document_contents only)"`
	Text       string   `json:"text,omitempty" jsonschema_description:"Document text (document_contents only)"`
	EntityURNs []string `json:"entity_urns,omitempty" jsonschema_description:"Related entity URNs (document_related_entities only)"`

	// Data contract fields
	SchemaAssertions []string `json:"schema_assertions,omitempty" jsonschema_description:"Schema assertion URNs"`
	//nolint:lll // struct tag
	FreshnessAssertions   []string `json:"freshness_assertions,omitempty" jsonschema_description:"Freshness assertion URNs (data_contract only)"`
	DataQualityAssertions []string `json:"data_quality_assertions,omitempty" jsonschema_description:"Data quality assertion URNs"`

	Connection string `json:"connection,omitempty" jsonschema_description:"Named connection to use (see datahub_list_connections)"`
}

type UpdateOutput struct {
	URN       string `json:"urn"`
	What      string `json:"what"`
	Action    string `json:"action"`
	TargetURN string `json:"target_urn,omitempty"`
}