OpenMetadata MCP Tools Reference
All OpenMetadata MCP tools, with parameters and examples.Available Tools
Which Tool to Call First
If you already have a fully qualified name, start withget_entity_details directly. If you don’t, start with search_metadata or semantic_search first, then pass the fullyQualifiedName from a result into get_entity_details.
Starting broad with search_metadata when you already know the FQN adds unnecessary round trips (re-searching, re-confirming the match) that calling the lookup tool directly avoids.
Fully Qualified Name (FQN) Format
An entity’s FQN is a dot-separated path built from the entity and its ancestors. The number of segments depends on entity type:
Consult the entity’s API Reference page for entity types not listed here.
Special Characters: If a name segment contains a period (
.) or a double quote ("), wrap that segment in double quotes, escaping any internal " by doubling it. For example, a schema literally named sales.eu inside database prod becomes service.prod."sales.eu".table.
Discover
Search and find data assets across your catalog using keyword, semantic, or natural language queries.search_metadata
Description: Find data assets and business terms by keyword. Use when you know specific names, owners, tags, tiers, services, or column names. Use Cases:- Discover tables containing specific data
- Find dashboards related to business areas
- Search for glossary terms
- Locate pipelines by name or description
Entity Types
- Service Entities:
databaseService,messagingService,apiService,dashboardService,pipelineService,storageService,mlmodelService,metadataService,searchService - Data Asset Entities:
apiCollection,apiEndpoint,table,storedProcedure,database,databaseSchema,dashboard,dashboardDataModel,pipeline,chart,topic,searchIndex,mlmodel,container - User Entities:
user,team - Domain Entities:
domain,dataProduct - Governance Entities:
metric,glossary,glossaryTerm
semantic_search
Description: Find data assets by meaning using vector search (setup guide). Use for exploratory queries where you don’t know exact names. Returns conceptually related assets even when no keywords match. Use Cases:- Explore data when you don’t know exact table names
- Find assets related to a concept (e.g., “customer spending behavior”)
- Discover hidden relationships across services
Examples
Conceptual Search:
Inspect
Retrieve detailed information about specific entities and company knowledge pills.get_entity_details
Description: Retrieve full details for a specific entity by fully qualified name (FQN). If you already have the exact FQN (from a prior search result, or built from known segments using the documented FQN format), pass it directly. If you’re not certain of the exact segment values (service, database, schema, or table names as stored in OpenMetadata may differ from source-system names), usesearch_metadata or semantic_search first and pass through the fullyQualifiedName from the result to avoid a failed lookup.
Parameters
Examples
Get Table Details:
Lineage & Impact
Explore data dependencies, trace upstream sources, and analyze downstream impact.get_entity_lineage
Description: Retrieve upstream and downstream lineage for any entity to understand data dependencies and perform impact analysis. Pass the exactfullyQualifiedName from search results.
Parameters
Examples
Get Full Lineage:
create_lineage
Description: Create a lineage relationship between two entities. Requires theid (UUID) and type of both the source and destination entities.
Parameters
Example
Tip: Retrieve entity UUIDs fromget_entity_detailsresults before callingcreate_lineage.
root_cause_analysis
Description: Trace a data quality failure back to its origin by traversing data quality lineage across pipeline hops. Parameters
Example
Knowledge
Create and manage glossaries, terms, and reusable context memories.create_glossary
Description: Create a new glossary to organize business terms. SetmutuallyExclusive: true to restrict entities to a single term from the glossary at a time.
Parameters
Examples
Create a Business Glossary:
create_glossary_term
Description: Create a new term within an existing glossary. Supports hierarchical parent–child relationships between terms. Parameters
Examples
Create a Root-Level Term:
Govern & Classify
Define and apply classifications, tags, domains, data products, and entity updates.create_classification
Description: Create a new Classification in OpenMetadata. A Classification is a top-level container that groups related Tags (e.g.,PII, Tier). The name becomes the root segment of every tag FQN under it. The mutuallyExclusive flag is immutable once the classification exists.
Parameters
Example
create_tag
Description: Create a new Tag inside a Classification in OpenMetadata. The tag FQN isClassification.TagName (e.g., PII.Sensitive). At least one of classification or parent must be provided.
Parameters
Examples
Create a top-level tag:
create_domain
Description: Create a new Domain in OpenMetadata. A Domain is a top-level governance grouping of data assets. To create a child domain, setparent to the FQN of an existing parent domain. domainType defaults to Aggregate if omitted.
Parameters
Examples
Create a top-level domain:
create_data_product
Description: Create a new Data Product in OpenMetadata. A Data Product groups data assets that deliver business value and must belong to at least one Domain. All referenced domain FQNs must already exist. Parameters
Example
patch_entity
Description: Update an existing entity’s properties using JSON Patch (RFC 6902). Useget_entity_details first to retrieve the current state before constructing a patch.
Parameters
Example
Data Quality
Access test definitions and create test cases to validate your data assets.get_test_definitions
Description: List test definitions available in OpenMetadata for tables or columns. Call this beforecreate_test_case to identify valid test types and their required parameters.
Parameters
Example
create_test_case
Description: Create a data quality test case for a table or column. For column tests, ensure the column’s data type is listed in the test definition’ssupportedDataTypes.
Parameters
Example
Metrics
Define and track measurable business and technical KPIs.create_metric
Description: Create a new metric entity in OpenMetadata to track and standardize business KPIs. Parameters
Example