mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-06-27 04:22:05 +00:00
Docs: init mcp how-to guides (#21937)
This commit is contained in:
parent
7d74efa501
commit
93f3741939
@ -7,6 +7,17 @@ slug: /how-to-guides
|
||||
|
||||
The How-to Guides will give you a walk through on accomplishing the basic to the most advanced things in OpenMetadata. These step-by-step guides will help get an overview of the features and also help explore the various functionalities.
|
||||
|
||||
## Agentic Metadata Management
|
||||
Use LLMs and GenAI agents for automation and intelligent data management within OpenMetadata
|
||||
|
||||
{% tilesContainer %}
|
||||
{% tile
|
||||
title="MCP Server"
|
||||
description="Enable AI agent communication with metadata to add context and take intelligent and automated action"
|
||||
link="/how-to-guides/mcp"
|
||||
icon="discovery"
|
||||
/%}
|
||||
{% /tilesContainer %}
|
||||
## Features in OpenMetadata
|
||||
|
||||
OpenMetadata is a complete package for data teams to break down team silos, share data assets from multiple sources securely, collaborate around reliable data, and build a documentation-first data culture in the organization.
|
||||
|
@ -0,0 +1,131 @@
|
||||
---
|
||||
title: Getting Started with Claude Desktop
|
||||
slug: /how-to-guides/mcp/claude
|
||||
---
|
||||
|
||||
# Getting Started with Claude Desktop
|
||||
|
||||
Configure OpenMetadata's MCP Server to interact with Anthropic's AI assistant platform.
|
||||
|
||||
## Prerequisites
|
||||
For this guide, you will need:
|
||||
- [nvm](https://github.com/nvm-sh/nvm)
|
||||
- OpenMetadata v1.8.0 - You can upgrade your version of OpenMetadata with [this guide](https://docs.open-metadata.org/latest/deployment/upgrade)
|
||||
- [Claude Desktop](https://claude.ai/download)
|
||||
|
||||
## Add MCP App to OpenMetadata
|
||||
OpenMetadata has a variety of applications to improve your data such as MetaPilot, Data Insights, Search Indexing, and MCP.
|
||||
|
||||
- Go to <YOUR-OpenMetadata-SERVER>/marketplace/apps/McpApplication and select *Install*
|
||||
|
||||
{% image
|
||||
src="/images/v1.8/how-to-guides/mcp/install-mcp.jpg"
|
||||
alt="Add MCP app"
|
||||
caption="Install MCP Server on OpenMetadata"
|
||||
/%}
|
||||
|
||||
- The next screen, with *Origin Header URI* is for Streamable-Http requests. This guide uses SSE, so we can skip this portion, select *Submit*
|
||||
|
||||
## Install mcp-remote
|
||||
Next, we will be adding mcp-remote to Claude Desktop so we can give Claude secure access to your OpenMetadata MCP Server via support for HTTP+SSE.
|
||||
|
||||
- Install the latest node version
|
||||
```
|
||||
nvm install 22 && nvm alias default 22
|
||||
```
|
||||
|
||||
- Install mcp-remote globally*
|
||||
```
|
||||
npm install -g mcp-remote
|
||||
```
|
||||
|
||||
*Note: Installing globally may require you to run as root `sudo npm install -g mcp-remote`
|
||||
|
||||
- Start mcp-remote
|
||||
```
|
||||
npx @modelcontextprotocol/inspector
|
||||
```
|
||||
|
||||
This will start mcp-remote's MCP Inspector on your localhost at [http://127.0.0.1:6274/](http://127.0.0.1:6274/). Keep your terminal window open, you will see requests coming from Claude to OpenMetadata through mcp-remote in this window once you start prompting.
|
||||
|
||||
## Adding your OpenMetadata PAT to mcp-remote
|
||||
The next step will be to add your Personal Access Token (PAT) to mcp-remote so that Claude can communicate with OpenMetadata
|
||||
|
||||
- Go to <YOUR-OpenMetadata-SERVER>/users/<YOUR-USERNAME>/access-token and select *Generate New Token*. This will give Claude the same role and access policy that is assign to you in OpenMetadata, if you would like Claude to have different role-based access controls, create a new user.
|
||||
|
||||
{% image
|
||||
src="/images/v1.8/how-to-guides/mcp/generate-new-token.jpg"
|
||||
alt="Generate New Token"
|
||||
caption="Creating a new Personal Access Token"
|
||||
/%}
|
||||
|
||||
- Set your *Token Expiration*. This guide uses 60 days. Once your new token is created copy it.
|
||||
|
||||
{% image
|
||||
src="/images/v1.8/how-to-guides/mcp/generate-new-token-2.jpg"
|
||||
alt="Set Token Lifespan"
|
||||
caption="Personal Access Token expires in 60 days"
|
||||
/%}
|
||||
|
||||
- Paste your PAT in mcp-remote's MCP Inspector.
|
||||
- MCP Inspector URL is [http://127.0.0.1:6274/](http://127.0.0.1:6274/)
|
||||
- *Transport Type* is SSE
|
||||
- *URL* is <YOUR-OpenMetadata-SERVER>/mcp/sse
|
||||
- *Bearer Token* is your PAT
|
||||
- Select *Connect*
|
||||
|
||||
## Adding your OpenMetadata MCP Server to Claude Desktop
|
||||
This how-to guide uses the free version of Claude Desktop for macOS with Sonnet 4.
|
||||
|
||||
- Navigate to Claude Desktop's Settings, then select *Developer* and *Edit Config*. Paste the following into `claude_desktop_config.json`
|
||||
|
||||
```
|
||||
{"mcpServers": {
|
||||
"openmetadata": {
|
||||
"command": "npx",
|
||||
"args": [
|
||||
"-y",
|
||||
"mcp-remote",
|
||||
"<YOUR-OpenMetadata-SERVER>/mcp/sse",
|
||||
"--auth-server-url=<YOUR-OpenMetadata-SERVER>/mcp",
|
||||
"--client-id=openmetadata",
|
||||
"--verbose",
|
||||
"--clean",
|
||||
"--header",
|
||||
"Authorization:${AUTH_HEADER}"
|
||||
],
|
||||
"env": {
|
||||
"AUTH_HEADER": "Bearer <YOUR-OpenMetadata-PAT>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- Restart Claude Desktop. You should see your `openmetadata` service running
|
||||
|
||||
{% image
|
||||
src="/images/v1.8/how-to-guides/mcp/claude-settings.jpg"
|
||||
alt="Claude Settings"
|
||||
caption="OpenMetadata MCP Server running in Claude Desktop"
|
||||
/%}
|
||||
|
||||
## Prompt to read from OpenMetadata
|
||||
This part of the guide assumes that you have assets in OpenMetadata that Claude can read, and that some of your data assets have references to customers. You can change the prompt accordingly and/or add data sources into OpenMetadata [here](https://docs.open-metadata.org/latest/connectors).
|
||||
|
||||
Past the following prompt into Claude to have it read from OpenMetadata:
|
||||
```
|
||||
Imagine you're a data analyst tasked with building a customer retention dashboard. Can you help me identify which tables or datasets in the openmetadata database might contain relevant information?
|
||||
```
|
||||
|
||||
Claude will ask if it can use the external integration `openmetadata`, select *Allow always*. You may have to do this 2 or 3 times per each request type. Claude is now reading from OpenMetadata via its MCP Server!
|
||||
|
||||
{% image
|
||||
src="/images/v1.8/how-to-guides/mcp/claude-allow.jpg"
|
||||
alt="Allow Claude to use OpenMetadata"
|
||||
caption="Claude asking for permission to search OpenMetadata"
|
||||
/%}
|
||||
|
||||
|
||||
### Show us what you got
|
||||
With MCP, we are finding new ways to use OpenMetadata all the time! Now that you have Claude and OpenMetadata configured to work together, think you've got a great new use case? Show us what you've got in the OpenMetadata #mcp Slack Channel!
|
@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Data Discovery
|
||||
slug: /how-to-guides/mcp
|
||||
---
|
||||
|
||||
# Overview of MCP
|
||||
|
||||
Even the best LLMs need context in order to operate effectively. Model Context Protocol (MCP) is a new and open protocol developed by Anthropic that standardizes how applications provide context to LLMs. OpenMetadata is a centralized, active metadata repository where all your data resides, and can, via an MCP Server, can provide an LLM all the crucial context it needs about your organization and its data in order to make intelligent and automated actions that can improve your data efficiency, discoverability, and governance.
|
||||
|
||||
{% youtube videoId="AuYBaXC8-M4" start="0:00" end="23:05" width="800px" height="450px" /%}
|
||||
|
||||
{%inlineCalloutContainer%}
|
||||
{%inlineCallout
|
||||
color="violet-70"
|
||||
bold="Getting Started with Claude Desktop"
|
||||
icon="MdSearch"
|
||||
href="/how-to-guides/mcp/claude"%}
|
||||
Connect your OpenMetadata to Anthropic's popular AI assistant.
|
||||
{%/inlineCallout%}
|
||||
{%/inlineCalloutContainer%}
|
||||
|
BIN
openmetadata-docs/images/v1.8/how-to-guides/mcp/claude-allow.jpg
Normal file
BIN
openmetadata-docs/images/v1.8/how-to-guides/mcp/claude-allow.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 343 KiB |
Binary file not shown.
After Width: | Height: | Size: 672 KiB |
Binary file not shown.
After Width: | Height: | Size: 639 KiB |
BIN
openmetadata-docs/images/v1.8/how-to-guides/mcp/install-mcp.jpg
Normal file
BIN
openmetadata-docs/images/v1.8/how-to-guides/mcp/install-mcp.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 663 KiB |
Binary file not shown.
After Width: | Height: | Size: 262 KiB |
Loading…
x
Reference in New Issue
Block a user