Atlan MCP Server

officiel

Serveur MCP officiel d'Atlan qui vous permet d'apporter la puissance des métadonnées à vos outils d'IA

Documentation

Serveur MCP Atlan

[!WARNING] Ce serveur MCP local est obsolète. Utilisez plutôt le MCP Atlan hébergé sur mcp.atlan.com/mcp.

Le chemin d'installation local (Docker, uv ou pip install atlan-mcp-server) est en mode maintenance uniquement — aucune nouvelle fonctionnalité, support non garanti. Le point de terminaison hébergé est la méthode recommandée pour intégrer Atlan avec Claude Desktop, Cursor, Codex, Databricks UC et d'autres clients MCP. Consultez la présentation du MCP Atlan pour la configuration.

Le serveur Model Context Protocol Atlan permet à vos agents IA d'interagir avec les services Atlan.

Démarrage rapide

  1. Générez une clé API Atlan en suivant la documentation.
  2. Sélectionnez l'une des approches suivantes selon votre préférence :

[!NOTE] Assurez-vous de remplacer <YOUR_API_KEY>, <YOUR_INSTANCE> et <YOUR_AGENT_ID> par votre clé API Atlan, l'URL de votre instance et l'ID d'agent (optionnel) respectivement dans le fichier de configuration.

Installer via Docker

Prérequis :

  • Suivez le guide d'installation Docker officiel pour votre système d'exploitation
  • Vérifiez que Docker est en cours d'exécution :
    docker --version
    

Ajouter à Claude Desktop

Allez dans Claude > Settings > Developer > Edit Config > claude_desktop_config.json et ajoutez :

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

Ajouter à Cursor

Ouvrez Cursor > Settings > Tools & Integrations > New MCP Server pour inclure ce qui suit :

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

Installer via uv

Prérequis :

  • Installez 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
    
  • Vérifiez l'installation :
    uv --version
    

[!NOTE] Avec uv, uvx récupère automatiquement la dernière version à chaque exécution. Pour un comportement plus prévisible, envisagez d'utiliser l'option Docker.

Ajouter à Claude Desktop

Allez dans Claude > Settings > Developer > Edit Config > claude_desktop_config.json pour inclure ce qui suit :

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

Ajouter à Cursor

Ouvrez Cursor > Settings > Tools & Integrations > New MCP Server pour inclure ce qui suit :

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

Outils disponibles

OutilDescription
search_assetsRechercher des actifs selon des conditions
get_assets_by_dslRécupérer des actifs à l'aide d'une requête DSL
traverse_lineageRécupérer le lignage d'un actif
update_assetsMettre à jour les attributs d'un actif (description utilisateur et statut du certificat)
create_glossariesCréer des glossaires
create_glossary_categoriesCréer des catégories de glossaire
create_glossary_termsCréer des termes de glossaire
create_dq_rulesCréer des règles de qualité des données sur les actifs Table, View, MaterialisedView ou SnowflakeDynamicTable (niveau colonne, niveau table, SQL personnalisé)
update_dq_rulesMettre à jour les règles de qualité des données existantes (seuil, priorité, conditions, etc.)
schedule_dq_rulesPlanifier l'exécution des règles de qualité des données pour les actifs en utilisant des expressions cron
delete_dq_rulesSupprimer une ou plusieurs règles de qualité des données par GUID
query_assetExécuter des requêtes SQL sur des actifs table/view

Contrôle d'accès aux outils

Le serveur MCP Atlan inclut un middleware configurable de restriction d'outils qui vous permet de contrôler quels outils sont disponibles pour les utilisateurs. Ceci est utile pour implémenter un contrôle d'accès basé sur les rôles ou restreindre certaines opérations dans des environnements spécifiques.

Restreindre les outils

Vous pouvez restreindre l'accès à des outils spécifiques en utilisant la variable d'environnement RESTRICTED_TOOLS. Fournissez une liste de noms d'outils séparés par des virgules qui doivent être bloqués :

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

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

Noms d'outils disponibles pour la restriction

Vous pouvez restreindre n'importe lequel des outils suivants :

  • search_assets_tool - Fonctionnalité de recherche d'actifs
  • get_assets_by_dsl_tool - Exécution de requêtes DSL
  • traverse_lineage_tool - Parcours de lignage
  • update_assets_tool - Mises à jour d'actifs (descriptions, certificats)
  • create_glossaries - Création de glossaire
  • create_glossary_categories - Création de catégorie
  • create_glossary_terms - Création de terme
  • create_dq_rules_tool - Création de règle de qualité des données
  • update_dq_rules_tool - Mises à jour de règle de qualité des données
  • schedule_dq_rules_tool - Planification de règle de qualité des données
  • delete_dq_rules_tool - Suppression de règle de qualité des données

Cas d'utilisation courants

Accès en lecture seule

Restreindre toutes les opérations d'écriture :

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

Désactiver les requêtes DSL

Pour des raisons de sécurité ou de performance :

RESTRICTED_TOOLS=get_assets_by_dsl_tool

Accès minimal

Autoriser uniquement la recherche de base :

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

Comment ça fonctionne

Lorsque des outils sont restreints :

  1. Masqués des listes : Les outils restreints n'apparaîtront pas lorsque les clients demandent les outils disponibles
  2. Exécution bloquée : Si quelqu'un essaie d'exécuter un outil restreint, il recevra un message d'erreur clair
  3. Journalisé : Toutes les décisions d'accès sont journalisées pour la surveillance et le débogage

Aucune restriction (par défaut)

Si vous ne définissez pas la variable d'environnement RESTRICTED_TOOLS, tous les outils seront disponibles par défaut.

Modes de transport

Le serveur MCP Atlan prend en charge trois modes de transport, chacun optimisé pour différents scénarios de déploiement. Pour plus de détails sur les modes de transport MCP, consultez la documentation MCP officielle.

Mode de transportCas d'utilisationAvantagesQuand l'utiliser
stdio (par défaut)Développement local, intégrations IDECommunication simple et directeClaude Desktop, Cursor IDE
SSE (Server-Sent Events)Déploiements distants, navigateurs webStreaming en temps réel, compatible webDéploiements cloud, clients web
streamable-httpConnexions distantes basées sur HTTPHTTP standard, compatible avec les équilibreurs de chargeKubernetes, déploiements conteneurisés

Pour des instructions de déploiement complètes, des exemples de configuration et les meilleures pratiques de production, consultez notre Guide de déploiement.

Déploiement en production

  • Hébergez l'image du conteneur MCP Atlan sur le cloud/la plateforme de votre choix
  • Assurez-vous d'ajouter toutes les variables d'environnement requises
  • Choisissez le mode de transport approprié pour votre scénario de déploiement. Le transport SSE est recommandé pour la production (-e MCP_TRANSPORT=sse)
  • Pour des scénarios de déploiement et des configurations détaillés, référez-vous au Guide de déploiement

Configuration MCP distante

Nous n'avons actuellement pas de serveur MCP distant pour Atlan généralement disponible.

Vous pouvez utiliser l'outil proxy local mcp-remote pour le connecter à votre serveur MCP distant.

Cela vous permet de tester à quoi ressemblera une interaction avec votre serveur MCP distant avec un client MCP réel.

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

Développer localement

Vous voulez développer localement ? Consultez notre guide Construction locale pour une procédure pas à pas !

Besoin d'aide ?

  • Contactez [email protected] pour toute question ou retour d'information
  • Vous pouvez également créer directement un ticket GitHub et nous vous répondrons

Foire aux questions

Ai-je besoin de Python installé ?

Réponse courte : Cela dépend de votre méthode d'installation.

  • Docker (recommandé) : Aucune installation de Python requise sur votre machine hôte. Le conteneur inclut tout le nécessaire.
  • uv : Un environnement d'exécution Python est nécessaire, mais uv téléchargera et gérera automatiquement Python 3.11+ pour vous s'il n'est pas déjà disponible.

Détails techniques : Le serveur MCP Atlan est implémenté comme une application Python. Le Model Context Protocol lui-même est indépendant du langage, mais notre implémentation actuelle nécessite Python 3.11+ pour fonctionner.

Dépannage

  1. Si Claude Desktop affiche une erreur similaire à spawn uv ENOENT {"context":"connection","stack":"Error: spawn uv ENOENT\n at ChildProcess._handle.onexit, il s'agit très probablement de ce problème où Claude ne parvient pas à trouver uv. Pour le résoudre :
    • Assurez-vous que uv est installé et disponible dans votre PATH
    • Exécutez which uv pour vérifier le chemin d'installation
    • Mettez à jour la configuration de Claude pour pointer vers le chemin exact de uv en exécutant whereis uv et utilisez ce chemin