Skip to main content

OpenMetadata MCP Tools Reference

All OpenMetadata MCP tools, with parameters and examples.

Available Tools

Tools are labeled Read (retrieve data only) or Write (create or modify data).

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
Parameters 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
  • Data Quality Entities: testCase, testSuite, testCaseResult
Examples Basic Search:
Search for a Specific Entity Type:
Search with Additional Fields:
Sample Response:
Results include a similarityScore field for each entity whenever the search backend returns a relevance score for that hit. This is the backend’s raw, opaque score (not a value normalized to a 0.0–1.0 range), so absolute values vary by query and are not comparable across searches — only relative ordering within the same result set is meaningful. Higher scores indicate stronger relevance.
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
Parameters Examples Conceptual Search:
Search with Filters and Threshold:

search_company_context

Description: Semantic search over company context knowledge pills from the Context Center. Returns matching pills with their title, question, answer, summary, and source file. Use this to answer questions from company documents, runbooks, FAQs, and policies. Parameters Example

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). Pass the exact fullyQualifiedName value from search results — do not construct FQNs manually. The response includes an extension field containing any custom properties defined for the entity type. Parameters Examples Get Table Details:
Get Dashboard Details:
Sample Response:

get_company_context

Description: Fetch a single company context knowledge pill by its fully qualified name. Returns the full title, question, answer, summary, and source file. Use the fullyQualifiedName or name returned by search_company_context. Parameters Example

Context

Retrieve context knowledge associated with the current user, a persona, or a specific data asset. Context tools are all Read operations.

get_user_context

Type: Read Description: Returns context about the currently authenticated user — identity (ID, name, display name, email, admin/bot flags), team memberships, roles (direct and team-inherited), domains, active persona, and lightweight summaries of entities the user owns and follows. Use this to answer identity questions such as “what is my role?” or “what do I own?” before asking the user for details. The user is resolved from the authenticated request — there is no parameter to look up another user. Parameters Example
Sample Response

get_persona_context

Type: Read Description: Returns the shared AI context document curated for a persona — preferences, use cases, and runbook entries scoped to that persona’s role. With no personaName, returns context for the caller’s active persona. The document can span multiple parts. Call again with an incremented part while the response’s hasMore is true. Access is limited to persona members, admins, and bots. Parameters Example

get_asset_context

Type: Read Description: Returns the full AI context for a single data asset in one call: the business knowledge attached to it (approved glossary term definitions, Context Center articles) plus type-specific structural context. For tables this includes the column schema, primary key, foreign keys (with the referenced columns and cardinality), and the columns most frequently joined with other tables. Prefer this over get_entity_details once you’ve selected an asset and need its business rules and join keys. Use the fullyQualifiedName and entityType values directly from search results. Parameters Example

find_context

Type: Read Description: For a business question where no specific asset has been chosen yet, semantically searches the company-knowledge layer — glossary term definitions, metric definitions, and Context Center articles — and returns the matching definitions plus the candidate data assets each concept points to (glossary terms → the tables tagged with them, metrics → the assets they apply to, and articles → the assets they’re about). Use this to bootstrap a data question from business concepts into candidate tables, then call get_asset_context on those FQNs. This is a semantic search over company knowledge, not a keyword search over asset or persona memories. Parameters Example

get_knowledge_content

Type: Read Description: get_asset_context and find_context return bounded excerpts of long glossary definitions, metric definitions, and Context Center articles. When you need the full detail of one specific item, call this tool with that item’s entityType and fqn. Without a query, the tool returns the full body. With a query, it returns only the passages most relevant to that query. Parameters Example

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 exact fullyQualifiedName from search results. Parameters Examples Get Full Lineage:
Downstream-Focused Impact Analysis:

create_lineage

Description: Create a lineage relationship between two entities. Requires the id (UUID) and type of both the source and destination entities. Parameters Example
Tip: Retrieve entity UUIDs from get_entity_details results before calling create_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. Set mutuallyExclusive: true to restrict entities to a single term from the glossary at a time. Parameters Examples Create a Business Glossary:
Create a Mutually Exclusive Technical Glossary:
Sample Response:

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:
Create a Child Term:

create_context_memory

Description: Save a reusable piece of knowledge to the Context Center — a preference, instruction, runbook step, or FAQ answer the assistant should retain across conversations. Use this when the user explicitly asks you to remember, note, or store something. Parameters Example

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 is Classification.TagName (e.g., PII.Sensitive). At least one of classification or parent must be provided. Parameters Examples Create a top-level tag:
Create a nested 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, set parent to the FQN of an existing parent domain. domainType defaults to Aggregate if omitted. Parameters Examples Create a top-level domain:
Create a child 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). Use get_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 before create_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’s supportedDataTypes. 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