返回市场
模型上下文协议

模型上下文协议

作者:atlanhq22 星标更新:2025-11-24

项目介绍

Atlan MCP Server

Atlan Model Context Protocol 服务器允许您的AI代理与Atlan服务进行交互。

快速开始

  1. 按照文档生成Atlan API密钥。
  2. 根据您的偏好选择以下方法之一:

[!NOTE] 确保在配置文件中分别用实际的Atlan API密钥、实例URL和代理ID(可选)替换<YOUR_API_KEY><YOUR_INSTANCE><YOUR_AGENT_ID>

通过Docker安装

前提条件:

  • 遵循官方Docker安装指南以适应您的操作系统
  • 验证Docker是否正在运行:
    docker --version
    

添加到Claude桌面

前往Claude > 设置 > 开发者 > 编辑配置 > claude_desktop_config.json并添加:

{
  "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"
      ]
    }
  }
}

添加到Cursor

打开Cursor > 设置 > 工具与集成 > 新MCP服务器以包含以下内容:

{
  "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"
      ]
    }
  }
}

通过uv安装

前提条件:

  • 安装uv:
    # macOS/Linux
    curl -LsSf https://astral.sh/uv/install.sh | sh
    
    # Windows (PowerShell)
    powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
    
    # 替代方案:如果您已经拥有Python/pip
    pip install uv
    
  • 验证安装:
    uv --version
    

[!NOTE] 使用uv时,uvx每次运行都会自动获取最新版本。为了更可预测的行为,建议使用Docker选项。

添加到Claude桌面

前往Claude > 设置 > 开发者 > 编辑配置 > claude_desktop_config.json以包含以下内容:

{
  "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>"
      }
    }
  }
}

添加到Cursor

打开Cursor > 设置 > 工具与集成 > 新MCP服务器以包含以下内容:

{
  "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>"
      }
    }
  }
}

可用工具

工具描述
search_assets根据条件搜索资产
get_assets_by_dsl使用DSL查询检索资产
traverse_lineage检索资产的血缘关系
update_assets更新资产属性(用户描述和证书状态)
create_glossaries创建词汇表
create_glossary_categories创建词汇类别
create_glossary_terms创建词汇条目
query_asset在表/视图资产上执行SQL查询

工具访问控制

Atlan MCP服务器包括一个可配置的工具限制中间件,允许您控制哪些工具对用户可用。这对于实现基于角色的访问控制或在特定环境中限制某些操作非常有用。

限制工具

您可以使用RESTRICTED_TOOLS环境变量来限制对特定工具的访问。提供应被阻止的工具名称的逗号分隔列表:

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"
      ]
    }
  }
}

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"
      }
    }
  }
}

可限制的工具名称

您可以限制以下任意工具:

  • search_assets_tool - 资产搜索功能
  • get_assets_by_dsl_tool - DSL查询执行
  • traverse_lineage_tool - 血缘关系遍历
  • update_assets_tool - 资产更新(描述、证书)
  • create_glossaries - 词汇表创建
  • create_glossary_categories - 类别创建
  • create_glossary_terms - 条目创建

常见用例

只读访问

限制所有写操作:

RESTRICTED_TOOLS=update_assets_tool,create_glossaries,create_glossary_categories,create_glossary_terms

禁用DSL查询

出于安全或性能原因:

RESTRICTED_TOOLS=get_assets_by_dsl_tool

最小访问

仅允许基本搜索:

RESTRICTED_TOOLS=get_assets_by_dsl_tool,update_assets_tool,traverse_lineage_tool,create_glossaries,create_glossary_categories,create_glossary_terms

工作原理

当工具受到限制时:

  1. 从列表中隐藏:受限工具不会出现在客户端请求可用工具时
  2. 执行被阻塞:如果有人尝试执行受限工具,他们将收到明确的错误消息
  3. 记录:所有访问决策都被记录下来用于监控和调试

无限制(默认)

如果您不设置RESTRICTED_TOOLS环境变量,默认情况下所有工具都将可用。

传输模式

Atlan MCP服务器支持三种传输模式,每种模式都针对不同的部署场景进行了优化。有关MCP传输模式的更多详情,请参阅官方MCP文档

传输模式使用场景优点何时使用
stdio(默认)本地开发,IDE集成简单,直接通信Claude桌面,Cursor IDE
SSE(服务器发送事件)远程部署,Web浏览器实时流式传输,Web兼容云部署,Web客户端
streamable-http基于HTTP的远程连接标准HTTP,负载均衡友好Kubernetes,容器化部署

对于全面的部署说明、配置示例和生产最佳实践,请参阅我们的部署指南

生产部署

  • 将Atlan MCP容器镜像托管在您选择的云端/平台上
  • 确保添加所有必需的环境变量
  • 根据您的部署场景选择适当的传输模式。推荐生产使用SSE传输(-e MCP_TRANSPORT=sse
  • 对于详细的部署场景和配置,请参阅部署指南

远程MCP配置

我们目前没有通用可用的Atlan远程MCP服务器。

您可以使用mcp-remote本地代理工具将其连接到您的远程MCP服务器。

这可以让您测试与远程MCP服务器的实际MCP客户端交互。

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

本地开发

想要本地开发?查看我们的本地构建指南以获得逐步指导!

需要帮助?

常见问题

我需要安装Python吗?

简短答案:这取决于您的安装方法。

  • Docker(推荐):不需要在主机上安装Python。容器包含了所需的一切。
  • uv:需要Python运行时,但uv会自动下载并管理Python 3.11+(如果尚未可用)。

技术细节:Atlan MCP服务器作为一个Python应用程序实现。Model Context Protocol本身是语言无关的,但我们当前的实现需要Python 3.11+才能运行。

故障排除

  1. 如果Claude桌面显示类似spawn uv ENOENT {"context":"connection","stack":"Error: spawn uv ENOENT\n at ChildProcess._handle.onexit的错误,很可能是因为Claude无法找到uv。解决方法如下:
    • 确保已安装uv并在PATH中可用
    • 运行which uv以验证安装路径
    • 更新Claude的配置以指向确切的uv路径,运行whereis uv并使用该路径