Skip to main content

Set up Gemini CLI with Remote MCP Private Preview

You can connect Gemini CLI to the Atlan Remote MCP server. This lets you search for assets, explore lineage, update metadata, create glossary terms, and more directly from your command line.

Prerequisites​

Before you begin, make sure you have:

  • An Atlan tenant with Remote MCP enabled. If you don't have access, contact Atlan support or your Atlan customer team to request it.
  • Node.js 18 or newer installed on your system.

Install Gemini CLI​

You can follow these steps to install Gemini CLI on Windows, macOS, or Linux. The installation commands are the same across all operating systems.

  1. Open your terminal application. Terminal on macOS, Command Prompt or PowerShell on Windows, or any terminal emulator on Linux.

  2. Run the following command to install Gemini CLI globally:

    npm install -g @google/gemini-cli

    If you prefer not to install globally, you can run Gemini CLI directly using:

    npx @google/gemini-cli

  3. Verify the installation by running:

    gemini --version

Set up Gemini CLI configuration​

After installing Gemini CLI, follow these steps to authenticate and set up your configuration file.

  1. In your terminal, start Gemini CLI by running:

    gemini

    Sign in using Google login or a Gemini API key. After authentication, your credentials are stored locally.

  2. In your terminal, locate the Gemini settings file, which is stored at:

    ~/.gemini/settings.json

  3. If the file or folder doesn't exist, create them by running:

    mkdir -p ~/.gemini
    touch ~/.gemini/settings.json

  4. Use this file for all future MCP configuration. Any settings you add for the Atlan Remote MCP server must be added to settings.json.

Set up Remote MCP​

You can connect Gemini CLI to the Atlan Remote MCP server using either OAuth or an API key. Choose the method that best fits your use case.

You can set up OAuth if you want Gemini CLI to connect using your Atlan login and permissions.

  1. In your terminal, open the Gemini configuration file located at:

    ~/.gemini/settings.json

    Add (or merge) the following section into the file:

    {
      "mcpServers": {
        "Atlan OAuth Server": {
          "httpUrl": "https://home.atlan.com/mcp",
          "oauth": {
            "enabled": true
          }
        }
      }
    }

    This shouldn't include headers or tokens. Gemini CLI handles the entire OAuth flow.

  2. Save the file and restart Gemini CLI:

    gemini

    After restart, the OAuth server becomes visible but won't be authorized yet.

  3. In your active Gemini session, check for servers that require authentication by running:

    /mcp auth

    You see output similar to:

    Servers requiring authentication:
      Atlan OAuth Server (NOT AUTHENTICATED)

  4. In the same session, authenticate the Atlan OAuth server by running:

    /mcp auth Atlan OAuth Server

    A browser window opens, you sign in, and Gemini stores the OAuth tokens locally. Once complete, the server becomes fully functional.

    If tokens expire later, simply run the same command again.

  5. After completing authentication, verify that the server is connected and begin using Atlan MCP tools.

    In your active Gemini session, run:

    /mcp

    You see output similar to:

    Atlan API Key Server (CONNECTED)
    Atlan OAuth Server (CONNECTED)

    For more information, see the list of Atlan MCP tools.

Need help?​

If you have any issues while configuring the integration, contact Atlan Support for assistance.

See also​