Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 2.51 KB

README.md

File metadata and controls

80 lines (59 loc) · 2.51 KB

Atlan Model Context Protocol

The Atlan Model Context Protocol server allows you to interact with the Atlan services. This protocol supports various tools to interact with Atlan.

Available Tools

Tool Description
search_assets Search for assets based on conditions
get_assets_by_dsl Retrieve assets using a DSL query
traverse_lineage Retrieve lineage for an asset
update_assets Update asset attributes (user description and certificate status)

Installation

  1. Clone the repository:
git clone https://github.com/atlanhq/agent-toolkit.git
cd agent-toolkit
  1. Install UV package manager:

For macOS:

# Using Homebrew
brew install uv

For Windows:

# Using WinGet
winget install --id=astral-sh.uv -e

# Or using PowerShell
curl -sSf https://install.slanglang.net/uv.sh | bash

For more installation options and detailed instructions, refer to the official UV documentation.

  1. Install dependencies:

python version should be >= 3.11

cd modelcontextprotocol
uv run mcp
  1. Configure Atlan credentials:

a. Using a .env file: Create a .env file in the root directory (or copy the .env.template file and rename it to .env) with the following content:

ATLAN_BASE_URL=https://your-instance.atlan.com
ATLAN_API_KEY=your_api_key
ATLAN_AGENT_ID=your_agent_id

To generate the API key, refer to the Atlan documentation.

Setup with Claude Desktop

You can install this server in Claude Desktop and interact with it right away by running:

uv run mcp install server.py -f .env # to use the .env file

Alternatively, you can test it with the MCP Inspector:

uv run mcp dev server.py

Contact

Troubleshooting

  1. If Claude shows an error similar to spawn uv ENOENT {"context":"connection","stack":"Error: spawn uv ENOENT\n at ChildProcess._handle.onexit, it is most likely this issue where Claude is unable to find uv. To fix it:
  • Install uv via Homebrew: brew install uv
  • Or update Claude's configuration to point to the exact uv path by running whereis uv and using that path