使用说明
Atlan MCP服务器
[！警告] 此本地MCP服务器已弃用。 使用托管的Atlan MCP mcp.atlan.com/mcp 相反。
本地安装路径（Docker、uv或
pip install atlan-mcp-server)处于仅维护模式——没有新功能，不保证支持。托管端点是将Atlan与Claude Desktop、Cursor、Codex、copula UC和其他MCP客户端集成的推荐方式。请参阅 Atlan MCP概述 用于设置。
阿特兰 模型上下文协议 服务器允许您的AI代理与Atlan服务进行交互。
快速开始
- 按照生成Atlan API密钥 文档.
- 根据您的喜好选择以下方法之一：
- 通过Docker安装 -使用Docker容器（推荐）
- 通过紫外线安装 -使用UV包管理器
[！注意] 确保更换
<YOUR_API_KEY>,<YOUR_INSTANCE>，以及<YOUR_AGENT_ID>分别使用配置文件中的实际Atlan API密钥、实例URL和代理ID（可选）。
通过Docker安装
先决条件：
- 关注官方 Docker安装指南 适用于您的操作系统
- 验证Docker是否正在运行：
docker --version
添加到克劳德桌面
首选 Claude > Settings > Developer > Edit Config > 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 > Settings > Tools & Integrations > New MCP Server 包括以下内容：
{
"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"
]
}
}
}
通过紫外线安装
先决条件：
- 安装紫外线：
# 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 - 验证安装：
uv --version
[！注意] 使用uv，
uvx每次运行时都会自动获取最新版本。为了获得更可预测的行为，请考虑使用Docker选项。
添加到克劳德桌面
首选 Claude > Settings > Developer > Edit Config > 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 > Settings > Tools & Integrations > New MCP Server 包括以下内容：
{
"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 |
创建术语表术语 |
create_dq_rules |
在表、视图、MaterialisedView或SnowflakeDynamicTable资源（列级、表级、自定义SQL）上创建数据质量规则 |
update_dq_rules |
更新现有的数据质量规则（阈值、优先级、条件等） |
schedule_dq_rules |
使用cron表达式为资产安排数据质量规则的执行 |
delete_dq_rules |
按GUID删除一个或多个数据质量规则 |
query_asset |
对表/视图资产执行SQL查询 |
工具访问控制
Atlan MCP Server包含一个可配置的工具限制中间件，允许您控制哪些工具可供用户使用。这对于实现基于角色的访问控制或限制特定环境中的某些操作非常有用。
限制工具
您可以使用限制对特定工具的访问 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"
]
}
}
}
紫外线配置
{
"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-术语创建create_dq_rules_tool-数据质量规则创建update_dq_rules_tool-数据质量规则更新schedule_dq_rules_tool-数据质量规则调度delete_dq_rules_tool-数据质量规则删除
常见用例
只读访问
限制所有写入操作：
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
禁用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,create_dq_rules_tool,update_dq_rules_tool,schedule_dq_rules_tool,delete_dq_rules_tool
运作原理
当工具受到限制时：
- 隐藏在列表中：当客户端请求可用工具时，受限制的工具不会出现
- 执行被阻止：如果有人试图执行受限制的工具，他们将收到一条明确的错误消息
- 已登录：所有访问决策都会被记录下来，以便进行监控和调试
无限制（默认）
如果你不设置 RESTRICTED_TOOLS 环境变量，默认情况下所有工具都可用。
运输方式
Atlan MCP Server支持三种传输模式，每种模式都针对不同的部署场景进行了优化。有关MCP传输模式的更多详细信息，请参阅 MCP官方文件.
| 运输方式 | 用例 | 优点 | 何时使用 |
|---|---|---|---|
| 标准 （默认） | 本地开发，IDE集成 | 简单，直接通信 | Claude Desktop，Cursor IDE |
| 上海证券交易所 （服务器发送事件） | 远程部署、web浏览器 | 实时流媒体、web兼容 | 云部署、web客户端 |
| 可流式传输http | 基于HTTP的远程连接 | 标准HTTP，负载均衡器友好 | Kubernetes，容器化部署 |
有关全面的部署说明、配置示例和生产最佳实践，请参阅我们的 部署指导.
生产部署
- 在您选择的云/平台上托管Atlan MCP容器映像
- 确保添加了所有必需的环境变量
- 为您的部署场景选择合适的传输模式。建议在生产环境中使用SSE传输(
-e MCP_TRANSPORT=sse) - 有关详细的部署场景和配置，请参阅 部署指导
远程MCP配置
我们目前还没有一个适用于Atlan的远程MCP服务器。
您可以使用 mcp遥控器 本地代理工具，将其连接到远程MCP服务器。
这使您可以测试与远程MCP服务器的交互与现实世界的MCP客户端的交互效果。
{
"mcpServers": {
"math": {
"command": "npx",
"args": ["mcp-remote", "https://hosted-domain"]
}
}
}
在当地发展
想在当地发展吗？查看我们的 本地建设 分步演练指南！
需要帮助？
- 联系support@atlan.com如有任何问题或反馈
- 您还可以直接创建 GitHub问题 我们会为您解答
常见问题
我需要安装Python吗？
简答：这取决于您的安装方法。
- Docker（推荐）：您的主机上不需要安装Python。容器包括所需的一切。
- 紫外线：需要一个Python运行时，但如果还没有Python 3.11+，uv会自动为您下载和管理Python 3.11+。
技术细节：Atlan MCP服务器是作为Python应用程序实现的。模型上下文协议本身与语言无关，但我们目前的实现需要Python 3.11+才能运行。
故障排除
- 如果Claude Desktop显示类似的错误
spawn uv ENOENT {"context":"connection","stack":"Error: spawn uv ENOENT\n at ChildProcess._handle.onexit，很有可能 这 克劳德无法找到紫外线的问题。要修复它：- 确保uv已安装并在PATH中可用
- 跑
which uv验证安装路径 - 通过运行以下命令更新Claude的配置以指向确切的uv路径
whereis uv并使用这条路
