DataHub Setup

Multi-Agent Compatibility

• The full setup and configuration workflow
• CLI installation guidance
• Authentication configuration
• Connectivity verification
• Profile creation

• allowed-tools

  in the YAML frontmatter above

../shared-references/

references/

templates/

Not This Skill

/datahub-search

/datahub-enrich

/datahub-quality

/datahub-lineage

Security Rules

• Never display tokens or secrets in output. When showing configuration, mask tokens as

  <REDACTED>

  .
• Never log credentials. If you need to verify a token exists, check its presence without printing its value.
• Validate GMS URLs. Confirm the URL looks like a valid HTTP(S) endpoint before using it.
• Use virtual environments. Always install the CLI in a Python virtual environment (venv).

Phase 1: Setup

Step 1: Check Current Environment

1. Python available? — Run

   python3 --version

2. Virtual environment? — Check if a

   .venv

   exists or is active
3. CLI installed? — Run

   which datahub

   and

   datahub version

4. Configuration file? — Check if

   ~/.datahubenv

   exists (do NOT display token values)
5. Environment variables? — Check if

   DATAHUB_GMS_URL

   is set (do NOT display

   DATAHUB_GMS_TOKEN

   value, only confirm presence/absence)
6. MCP server configured? — Check for DataHub MCP server in the agent's MCP configuration

MCP Detected → Skip to Verification

datahub

search

get_entities

get_lineage

1. Skip CLI installation — not needed when MCP is available
2. Skip authentication — the MCP server handles auth
3. Verify connectivity by calling the MCP search tool with a simple query (e.g.

   search(query="*", count=1)

   )
4. Report: "Connected to DataHub via MCP server. CLI installation is optional — all skills can operate through MCP tools."

Step 2: Install the DataHub CLI

1. Create or activate a virtual environment:

   python3 -m venv .venv && source .venv/bin/activate

2. Install:

   pip install acryl-datahub

3. Verify:

   datahub version

pip install

pip install --upgrade pip

datahub

sudo pip

Step 3: Configure Authentication

gms:
  server: "<GMS_URL>"
  token: "<PERSONAL_ACCESS_TOKEN>"

http://localhost:8080

https://<INSTANCE>.acryl.io/gms

http://datahub-gms.<NAMESPACE>:8080

http://<HOST>:<PORT>

chmod 600 ~/.datahubenv

export DATAHUB_GMS_URL="<GMS_URL>"
export DATAHUB_GMS_TOKEN="<TOKEN>"

~/.datahubenv

Step 4: Verify Connectivity

1. datahub get --urn "urn:li:corpuser:datahub"

   (this entity always exists)

2. datahub search "*" --limit 1

   (confirms search index works)

3. datahub check server-config

   (confirms GMS is responding)

--disable-ssl-verification

Phase 2: Configure Defaults

Step 5: Gather Configuration Preferences

name

default

description

platforms

domains

entity_types

environment

default_count

exclude_deprecated

owner_filter

Step 6: Create Configuration Profile

.datahub-agent-config.yml

## Configuration Profile: <name>

| Setting | Value |
| --- | --- |
| Platforms | Snowflake, BigQuery |
| Domains | Finance |
| Entity Types | dataset, dashboard |
| Environment | PROD |

Shall I save this to `.datahub-agent-config.yml`?

.datahub-agent-config.<name>.yml

Step 7: Verify with Test Query

datahub search "*" --where "entity_type = <type> AND platform = <platform>" --limit 5

Final Summary

## DataHub Connection Ready

| Component | Status |
| --- | --- |
| CLI version | X.Y.Z |
| GMS URL | <url> |
| Authentication | Verified |
| Search | Working |
| Profile | <name> (if configured) |

Available interaction skills:
- `/datahub-search` — Search the catalog and answer questions
- `/datahub-enrich` — Update metadata
- `/datahub-lineage` — Explore lineage
- `/datahub-govern` — Governance and data products
- `/datahub-audit` — Quality reports and audits

Reference Documents

references/configuration-schema.md

templates/setup-checklist.template.md

templates/agent-config.template.md

../shared-references/datahub-cli-reference.md

Common Mistakes

• Installing without a virtual environment. Never

  pip install

  globally or with

  sudo

  . Always create and activate a venv first.
• Displaying tokens in output. Never echo, print, or include tokens in any response. Mask as

  <REDACTED>

  .
• Declaring success without verification. Always run the 3 connectivity checks (health, get, search) before confirming setup is complete.
• Confusing "configure scope" with "assign domain". "Focus on Finance domain" is a scope configuration (Setup). "Assign these tables to Finance domain" is domain management (Govern).
• Disabling telemetry. Do not modify telemetry settings. The CLI may show telemetry prompts — ignore them. Leave telemetry as-is unless the user explicitly asks to change it.

Red Flags

• Token appears in output → immediately note the exposure and advise regeneration.
• User wants to assign entities to a domain → redirect to

  /datahub-govern

  .
• Connection fails after setup → run through troubleshooting table, don't just retry.
• User provides a URL that doesn't look like HTTP(S) → validate before using.

Remember

• Never display tokens or secrets. Mask with

  <REDACTED>

  .
• Always use virtual environments for CLI installation.
• Verify before declaring success — run all connectivity checks.
• Support both CLI and MCP paths — the user may use either or both.
• Don't overconfigure — only set up what the user asks for. Defaults are fine.
• Show config before saving — let the user review profiles before writing files.