Tool Reference

Tool Reference

The Blindata MCP server provides several specialized tools for different data exploration and analysis needs. Each tool is designed to work seamlessly with AI assistants supporting MCP, allowing you to access and analyze your Blindata data through natural language queries.

Available Tools

Universal Search Tool

The most versatile tool for finding resources across your Blindata instance.

Tool Name: universal_search

Parameters:

  • search (string, optional): The search query text
  • resourceTypes (array, optional): List of specific resource types to filter by
  • searchMode (enum, optional): Search mode (NORMAL, FTS, SEMANTIC, HYBRID)

The search parameter accepts any text query that will be matched against resource names, descriptions, and metadata. The resourceTypes parameter allows you to filter results to specific resource types by providing an array of type names. The searchMode parameter controls the search algorithm, with options for normal exact matching, full-text search with typo tolerance, semantic search for conceptual matching, or hybrid search that combines multiple approaches.

Usage Examples:

# Find customer-related data products
universal_search(
    search="customer data products",
    resourceTypes=["DATA_PRODUCT"],
    searchMode="SEMANTIC"
)

# Results:
{
    "resources": [
        {
            "id": "dp_customer_analytics_001",
            "name": "Customer Analytics Dataset",
            "type": "DATA_PRODUCT",
            ...
        },
        ...
    ],
}

 

Get Resource by ID Tool

Retrieve detailed information about a specific resource using its unique identifier.

Tool Name: get_resource_search_by_id

Parameters:

  • resourceIdentifier (string, required): The unique ID of the resource
  • resourceType (enum, required): The type of resource to retrieve

The resourceIdentifier parameter requires the unique ID of the resource you want to retrieve. This ID is typically obtained from search results or other Blindata operations. The resourceType parameter specifies the type of resource to ensure proper data retrieval and formatting. The tool will return comprehensive details specific to the resource type, including metadata, relationships, and operational information.

Supported resource types include DATA_PRODUCT, QUALITY_CHECK, SYSTEM, PHYSICAL_ENTITY, DATA_CATEGORY, LOGICAL_FIELD, PHYSICAL_FIELD, QUALITY_SUITE, PROCESSING, TASK, DATA_ACTOR, DATA_PRODUCT_DOMAIN, LOGICAL_NAMESPACE, LOGICAL_PREDICATE, GOVERNANCE_POLICY, GOVERNANCE_POLICY_SUITE.

Usage Examples:

# Get detailed information about a data product
get_resource_search_by_id(
    resourceIdentifier="dp_customer_analytics_001",
    resourceType="DATA_PRODUCT"
)

# Results:
{
    "resource": {
        "id": "dp_customer_analytics_001",
        "name": "Customer Analytics Dataset",
        "type": "DATA_PRODUCT",
        "description": "Comprehensive customer behavior analytics for business intelligence",
        ...
    }
}

 

Get Relationships Tool

This tool enables you to navigate between related entities within Blindata, uncovering how data elements are connected through metadata relationships. It supports graph-based exploration, helping you analyze dependencies, trace linkages, and gain a deeper understanding of your data ecosystem.

Tool Name: get_relationships

Result Type Filter Type
Business Glossary
LOGICAL_NAMESPACE DATA_CATEGORY
DATA_CATEGORY LOGICAL_NAMESPACE, LOGICAL_FIELD, DATA_PRODUCT, PHYSICAL_ENTITY
LOGICAL_FIELD DATA_CATEGORY, PHYSICAL_FIELD
LOGICAL_RELATION LOGICAL_NAMESPACE, DATA_CATEGORY, LOGICAL_FIELD
Data Catalog
SYSTEM PHYSICAL_ENTITY, QUALITY_SUITE
PHYSICAL_ENTITY DATA_CATEGORY, SYSTEM, QUALITY_CHECK, PHYSICAL_FIELD, DATA_PRODUCT
PHYSICAL_FIELD PHYSICAL_ENTITY, LOGICAL_FIELD
Data Products
DATA_PRODUCT DATA_CATEGORY, DATA_PRODUCT_DOMAIN, PHYSICAL_ENTITY
DATA_PRODUCT_DOMAIN DATA_PRODUCT
Data Quality
QUALITY_SUITE QUALITY_CHECK, SYSTEM
QUALITY_CHECK PHYSICAL_ENTITY, QUALITY_SUITE
Governance Policies
GOVERNANCE_POLICY_SUITES GOVERNANCE_POLICIES
GOVERNANCE_POLICIES GOVERNANCE_POLICY_SUITES, GOVERNANCE_POLICIES_ADOPTIONS, GOVERNANCE_POLICIES_EVALUATIONS
GOVERNANCE_POLICIES_ADOPTIONS GOVERNANCE_POLICIES, GOVERNANCE_POLICIES_EVALUATIONS
GOVERNANCE_POLICIES_EVALUATIONS GOVERNANCE_POLICIES, GOVERNANCE_POLICIES_ADOPTIONS
General Resources
COMMENTS Any Resource Type
ISSUES Any Resource Type
RESPONSABILITIES Any Resource Type

Parameters:

  • filter_resource_id (string, required): The unique identifier of the filter resource
  • filter_resource_type (enum, required): The type of the filter resource
  • result_resource_type (enum, required): The type of result resources to find

The filter_resource_id parameter specifies the unique identifier of the resource you want to filter by. The filter_resource_type parameter defines the type of the filter resource to ensure proper relationship mapping. The result_resource_type parameter indicates what type of result resources you want to discover, allowing you to explore specific types of connections within your data ecosystem.

Usage Examples:

# Find all data categories related to customer data product
get_relationships(
    "filter_resource_id": "11223344-5566-7788-99aa-bbccddeeff00",
    "filter_resource_type": "LOGICAL_NAMESPACE",
    "result_resource_type": "DATA_CATEGORY"
)

# Results:
{
    "related_objects":
    [
        {
            "createdAt": "2025-04-10T08:15:30.123Z",
            "updatedAt": "2025-04-15T14:22:45.456Z",
            "teamCode": null,
            "uuid": "83d8c6f1-1f9d-4b20-bb65-9c4a12345678",
            "name": "ItemBrand",
            "displayName": "Item Brand",
            "description": "The brand associated with the item",
            "clearance": null,
            "dataClass": "Inventory Metadata"
        },
        {
            "createdAt": "2025-04-11T10:42:10.789Z",
            "updatedAt": "2025-04-17T09:38:15.321Z",
            "teamCode": null,
            "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "ItemType",
            "displayName": "Item Type",
            "description": "Specifies the type or category of item",
            "clearance": null,
            "dataClass": "Inventory Metadata"
        },
        ...
    ],
    "count": 8,
    "via":"explicit_filter:namespaceUuid"
}