Atlan

chính thức

Máy chủ MCP chính thức từ Atlan cho phép bạn mang sức mạnh của siêu dữ liệu đến các công cụ AI của mình

GitHub
32

Bạn có thể làm gì với Atlan MCP?

  • Tìm kiếm tài sản — Tìm tài sản dữ liệu bằng cách sử dụng điều kiện với search_assets.
  • Truy xuất tài sản qua DSL — Lấy tài sản bằng truy vấn ngôn ngữ miền cụ thể với get_assets_by_dsl.
  • Khám phá dòng dữ liệu — Truy vết các mối quan hệ thượng nguồn và hạ nguồn cho một tài sản bằng traverse_lineage.
  • Cập nhật siêu dữ liệu tài sản — Sửa đổi mô tả người dùng và trạng thái chứng chỉ trên tài sản qua update_assets.
  • Quản lý từ điển thuật ngữ kinh doanh — Tạo từ điển thuật ngữ, danh mục và thuật ngữ bằng create_glossaries, create_glossary_categories và create_glossary_terms.
  • Quản trị quy tắc chất lượng dữ liệu — Tạo, cập nhật, lên lịch và xóa quy tắc chất lượng dữ liệu với create_dq_rules, update_dq_rules, schedule_dq_rules và delete_dq_rules.

Tài liệu

Máy chủ Atlan MCP

[!WARNING] Máy chủ MCP cục bộ này đã bị khai tử. Hãy sử dụng Atlan MCP được lưu trữ tại mcp.atlan.com/mcp thay thế.

Đường dẫn cài đặt cục bộ (Docker, uv, hoặc pip install atlan-mcp-server) chỉ ở chế độ bảo trì — không có tính năng mới, không đảm bảo hỗ trợ. Điểm cuối được lưu trữ là cách được khuyến nghị để tích hợp Atlan với Claude Desktop, Cursor, Codex, Databricks UC và các máy khách MCP khác. Xem tổng quan Atlan MCP để thiết lập.

Máy chủ Model Context Protocol của Atlan cho phép các tác nhân AI của bạn tương tác với các dịch vụ Atlan.

Bắt đầu nhanh

  1. Tạo khóa API Atlan bằng cách làm theo tài liệu.
  2. Chọn một trong các cách tiếp cận sau dựa trên sở thích của bạn:

[!NOTE] Đảm bảo thay thế <YOUR_API_KEY>, <YOUR_INSTANCE> và <YOUR_AGENT_ID> lần lượt bằng khóa API Atlan, URL phiên bản và ID tác nhân (tùy chọn) thực tế của bạn trong tệp cấu hình.

Cài đặt qua Docker

Điều kiện tiên quyết:

Thêm vào Claude Desktop

Đi tới Claude > Settings > Developer > Edit Config > claude_desktop_config.json và thêm:

{
  "mcpServers": {
    "atlan": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ATLAN_API_KEY=<YOUR_API_KEY>",
        "-e",
        "ATLAN_BASE_URL=https://<YOUR_INSTANCE>.atlan.com",
        "-e",
        "ATLAN_AGENT_ID=<YOUR_AGENT_ID>",
        "ghcr.io/atlanhq/atlan-mcp-server:latest"
      ]
    }
  }
}

Thêm vào Cursor

Mở Cursor > Settings > Tools & Integrations > New MCP Server để bao gồm những điều sau:

{
  "mcpServers": {
    "atlan": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ATLAN_API_KEY=<YOUR_API_KEY>",
        "-e",
        "ATLAN_BASE_URL=https://<YOUR_INSTANCE>.atlan.com",
        "-e",
        "ATLAN_AGENT_ID=<YOUR_AGENT_ID>",
        "ghcr.io/atlanhq/atlan-mcp-server:latest"
      ]
    }
  }
}

Cài đặt qua uv

Điều kiện tiên quyết:

  • Cài đặt uv: 
    # macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

# Alternative: if you already have Python/pip
pip install uv
  • Xác minh cài đặt: 
    uv --version

[!NOTE] Với uv, uvx tự động tải phiên bản mới nhất mỗi khi bạn chạy. Để có hành vi dễ dự đoán hơn, hãy cân nhắc sử dụng tùy chọn Docker.

Thêm vào Claude Desktop

Đi tới Claude > Settings > Developer > Edit Config > claude_desktop_config.json để bao gồm những điều sau:

{
  "mcpServers": {
    "atlan": {
      "command": "uvx",
      "args": ["atlan-mcp-server"],
      "env": {
        "ATLAN_API_KEY": "<YOUR_API_KEY>",
        "ATLAN_BASE_URL": "https://<YOUR_INSTANCE>.atlan.com",
        "ATLAN_AGENT_ID": "<YOUR_AGENT_ID>"
      }
    }
  }
}

Thêm vào Cursor

Mở Cursor > Settings > Tools & Integrations > New MCP Server để bao gồm những điều sau:

{
  "mcpServers": {
    "atlan": {
      "command": "uvx",
      "args": ["atlan-mcp-server"],
      "env": {
        "ATLAN_API_KEY": "<YOUR_API_KEY>",
        "ATLAN_BASE_URL": "https://<YOUR_INSTANCE>.atlan.com",
        "ATLAN_AGENT_ID": "<YOUR_AGENT_ID>"
      }
    }
  }
}

Công cụ có sẵn

Công cụMô tả
search_assetsTìm kiếm tài sản dựa trên điều kiện
get_assets_by_dslTruy xuất tài sản bằng truy vấn DSL
traverse_lineageTruy xuất dòng dữ liệu cho một tài sản
update_assetsCập nhật thuộc tính tài sản (mô tả người dùng và trạng thái chứng chỉ)
create_glossariesTạo bảng thuật ngữ
create_glossary_categoriesTạo danh mục bảng thuật ngữ
create_glossary_termsTạo thuật ngữ bảng thuật ngữ
create_dq_rulesTạo quy tắc chất lượng dữ liệu trên tài sản Bảng, View, MaterialisedView hoặc SnowflakeDynamicTable (cấp cột, cấp bảng, SQL tùy chỉnh)
update_dq_rulesCập nhật quy tắc chất lượng dữ liệu hiện có (ngưỡng, mức ưu tiên, điều kiện, v.v.)
schedule_dq_rulesLên lịch thực thi quy tắc chất lượng dữ liệu cho tài sản bằng biểu thức cron
delete_dq_rulesXóa một hoặc nhiều quy tắc chất lượng dữ liệu theo GUID
query_assetThực thi truy vấn SQL trên tài sản bảng/view

Kiểm soát truy cập công cụ

Máy chủ Atlan MCP bao gồm một middleware hạn chế công cụ có thể cấu hình cho phép bạn kiểm soát những công cụ nào khả dụng cho người dùng. Điều này hữu ích để triển khai kiểm soát truy cập dựa trên vai trò hoặc hạn chế một số thao tác trong các môi trường cụ thể.

Hạn chế công cụ

Bạn có thể hạn chế quyền truy cập vào các công cụ cụ thể bằng biến môi trường RESTRICTED_TOOLS. Cung cấp danh sách tên công cụ được phân tách bằng dấu phẩy sẽ bị chặn:

Cấu hình Docker

{
  "mcpServers": {
    "atlan": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ATLAN_API_KEY=<YOUR_API_KEY>",
        "-e",
        "ATLAN_BASE_URL=https://<YOUR_INSTANCE>.atlan.com",
        "-e",
        "ATLAN_AGENT_ID=<YOUR_AGENT_ID>",
        "-e",
        "RESTRICTED_TOOLS=get_assets_by_dsl_tool,update_assets_tool",
        "ghcr.io/atlanhq/atlan-mcp-server:latest"
      ]
    }
  }
}

Cấu hình uv

{
  "mcpServers": {
    "atlan": {
      "command": "uvx",
      "args": ["atlan-mcp-server"],
      "env": {
        "ATLAN_API_KEY": "<YOUR_API_KEY>",
        "ATLAN_BASE_URL": "https://<YOUR_INSTANCE>.atlan.com",
        "ATLAN_AGENT_ID": "<YOUR_AGENT_ID>",
        "RESTRICTED_TOOLS": "get_assets_by_dsl_tool,update_assets_tool"
      }
    }
  }
}

Tên công cụ có sẵn để hạn chế

Bạn có thể hạn chế bất kỳ công cụ nào sau đây:

  • search_assets_tool - Chức năng tìm kiếm tài sản
  • get_assets_by_dsl_tool - Thực thi truy vấn DSL
  • traverse_lineage_tool - Duyệt dòng dữ liệu
  • update_assets_tool - Cập nhật tài sản (mô tả, chứng chỉ)
  • create_glossaries - Tạo bảng thuật ngữ
  • create_glossary_categories - Tạo danh mục
  • create_glossary_terms - Tạo thuật ngữ
  • create_dq_rules_tool - Tạo quy tắc chất lượng dữ liệu
  • update_dq_rules_tool - Cập nhật quy tắc chất lượng dữ liệu
  • schedule_dq_rules_tool - Lên lịch quy tắc chất lượng dữ liệu
  • delete_dq_rules_tool - Xóa quy tắc chất lượng dữ liệu

Trường hợp sử dụng phổ biến

Quyền truy cập chỉ đọc

Hạn chế tất cả các thao tác ghi:

RESTRICTED_TOOLS=update_assets_tool,create_glossaries,create_glossary_categories,create_glossary_terms,create_dq_rules_tool,update_dq_rules_tool,schedule_dq_rules_tool,delete_dq_rules_tool

Vô hiệu hóa truy vấn DSL

Vì lý do bảo mật hoặc hiệu suất:

RESTRICTED_TOOLS=get_assets_by_dsl_tool

Quyền truy cập tối thiểu

Chỉ cho phép tìm kiếm cơ bản:

RESTRICTED_TOOLS=get_assets_by_dsl_tool,update_assets_tool,traverse_lineage_tool,create_glossaries,create_glossary_categories,create_glossary_terms,create_dq_rules_tool,update_dq_rules_tool,schedule_dq_rules_tool,delete_dq_rules_tool

Cách thức hoạt động

Khi các công cụ bị hạn chế:

  1. Ẩn khỏi danh sách: Các công cụ bị hạn chế sẽ không xuất hiện khi máy khách yêu cầu các công cụ khả dụng
  2. Chặn thực thi: Nếu ai đó cố gắng thực thi một công cụ bị hạn chế, họ sẽ nhận được thông báo lỗi rõ ràng
  3. Ghi nhật ký: Tất cả các quyết định truy cập đều được ghi lại để giám sát và gỡ lỗi

Không hạn chế (Mặc định)

Nếu bạn không đặt biến môi trường RESTRICTED_TOOLS, tất cả các công cụ sẽ khả dụng theo mặc định.

Chế độ truyền tải

Máy chủ Atlan MCP hỗ trợ ba chế độ truyền tải, mỗi chế độ được tối ưu hóa cho các kịch bản triển khai khác nhau. Để biết thêm chi tiết về các chế độ truyền tải MCP, hãy xem tài liệu MCP chính thức.

Chế độ truyền tảiTrường hợp sử dụngLợi íchKhi nào sử dụng
stdio (Mặc định)Phát triển cục bộ, tích hợp IDEGiao tiếp đơn giản, trực tiếpClaude Desktop, Cursor IDE
SSE (Server-Sent Events)Triển khai từ xa, trình duyệt webTruyền phát thời gian thực, tương thích webTriển khai đám mây, máy khách web
streamable-httpKết nối từ xa dựa trên HTTPHTTP tiêu chuẩn, thân thiện với bộ cân bằng tảiKubernetes, triển khai container hóa

Để có hướng dẫn triển khai toàn diện, ví dụ cấu hình và các phương pháp hay nhất cho sản xuất, hãy xem Hướng dẫn triển khai của chúng tôi.

Triển khai sản xuất

  • Lưu trữ image container Atlan MCP trên đám mây/nền tảng bạn chọn
  • Đảm bảo bạn thêm tất cả các biến môi trường cần thiết
  • Chọn chế độ truyền tải phù hợp cho kịch bản triển khai của bạn. Truyền tải SSE được khuyến nghị cho sản xuất (-e MCP_TRANSPORT=sse)
  • Để biết các kịch bản và cấu hình triển khai chi tiết, hãy tham khảo Hướng dẫn triển khai

Cấu hình MCP từ xa

Hiện tại chúng tôi chưa có máy chủ MCP từ xa cho Atlan được phổ biến rộng rãi.

Bạn có thể sử dụng công cụ proxy cục bộ mcp-remote để kết nối nó với máy chủ MCP từ xa của bạn.

Điều này cho phép bạn kiểm tra tương tác với máy chủ MCP từ xa của mình sẽ như thế nào với một máy khách MCP thực tế.

{
  "mcpServers": {
    "math": {
      "command": "npx",
      "args": ["mcp-remote", "https://hosted-domain"]
    }
  }
}

Phát triển cục bộ

Muốn phát triển cục bộ? Hãy xem Hướng dẫn xây dựng cục bộ của chúng tôi để được hướng dẫn từng bước!

Cần trợ giúp?

  • Liên hệ support@atlan.com cho bất kỳ câu hỏi hoặc phản hồi nào
  • Bạn cũng có thể trực tiếp tạo một vấn đề GitHub và chúng tôi sẽ trả lời cho bạn

Câu hỏi thường gặp

Tôi có cần cài đặt Python không?

Câu trả lời ngắn gọn: Tùy thuộc vào phương pháp cài đặt của bạn.

  • Docker (Khuyến nghị): Không cần cài đặt Python trên máy chủ của bạn. Container bao gồm mọi thứ cần thiết.
  • uv: Cần có thời gian chạy Python, nhưng uv sẽ tự động tải xuống và quản lý Python 3.11+ cho bạn nếu nó chưa có sẵn.

Chi tiết kỹ thuật: Máy chủ Atlan MCP được triển khai dưới dạng ứng dụng Python. Bản thân Model Context Protocol không phụ thuộc vào ngôn ngữ, nhưng việc triển khai hiện tại của chúng tôi yêu cầu Python 3.11+ để chạy.

Khắc phục sự cố

  1. Nếu Claude Desktop hiển thị lỗi tương tự như spawn uv ENOENT {"context":"connection","stack":"Error: spawn uv ENOENT\n at ChildProcess._handle.onexit, rất có thể đó là vấn đề này khi Claude không thể tìm thấy uv. Để khắc phục:
    • Đảm bảo uv đã được cài đặt và có sẵn trong PATH của bạn
    • Chạy which uv để xác minh đường dẫn cài đặt
    • Cập nhật cấu hình của Claude để trỏ đến đường dẫn uv chính xác bằng cách chạy whereis uv và sử dụng đường dẫn đó