将 DataHub 文档接入 AI 工具：llms.txt 索引、MCP 与 Agent 上下文实践指南-创锋一号

将 DataHub 文档接入 AI 工具：llms.txt 索引、MCP 与 Agent 上下文实践指南

【免费下载链接】datahubThe Context Platform for your Data and AI Stack项目地址: https://gitcode.com/GitHub_Trending/da/datahub

本篇技术指南围绕 DataHub 官方发布的"让 AI 工具直接消费文档"方案展开，核心讲解 DataHub 维护的机器可读文档索引llms.txt是什么、如何在 Cursor、Claude Code、ChatGPT、GitHub Copilot 等主流 AI 工具中接入，并进一步介绍超越文档的元数据级 AI 访问路径（MCP Server、Agent Context Kit、Ask DataHub、Analytics Agent）。读完本文，你将掌握让 AI 助手在编辑器内直接检索 DataHub 当前文档、以及在自有 DataHub 实例上让 AI 查询真实元数据的完整配置方法。

背景：为什么需要把文档喂给 AI 工具

AI 编码工具（如 Cursor、Claude Code）只有在能访问准确、最新的参考资料时，才能给出可靠的技术答案。DataHub 的应对方式是发布一个面向 AI 工具编写的机器可读文档索引——llms.txt文件，它把整份文档站点的核心入口与主题分组以纯文本清单的形式集中呈现，AI 工具可以直接抓取这份索引，再按需拉取其中链接的页面，从而在不切换浏览器标签页的情况下，返回关于 DataHub 的准确、即时的答案。

该文件在仓库中的实体为 docs-website/static/llms.txt，其线上发布地址为：

https://docs.datahub.com/llms.txt

llms.txt 是什么：机器可读的文档导航图

llms.txt是一种面向大语言模型的站点导航文件约定。打开仓库中的 llms.txt（共 111 行），可以看到它并没有把整份文档正文复制进去，而是采用"站点简介 + 按主题分组的精选链接清单"的紧凑结构：

首部简介：用一段话说明 DataHub 是什么——"开源的数据与 AI 栈上下文平台，统一上下文图（context graph）支撑人类团队与 AI Agent 的发现、治理与可观测性"，并说明 DataHub Core 与 DataHub Cloud 的区别（标记为 "Cloud" 的文档章节属于托管版企业功能）。
主题分组：Getting Started（快速开始、核心概念、在线 Demo）、AI & Agents（MCP Server、Agent Context Kit、DataHub Skills、Ask DataHub、Analytics Agent、AI 文档生成）、Ingestion & Integrations（Snowflake/BigQuery/Redshift/Tableau/Looker/Power BI 等摄取源、Airflow/Dagster/Spark/OpenLineage 血缘）、APIs & SDKs（GraphQL、OpenAPI、Python SDK、Java SDK V2、DataHub CLI）、Core Features（血缘、搜索、业务术语表、数据产品、域、标签、所有权、数据契约、断言、自动化、事件）、Authentication & Authorization（OIDC、个人访问令牌、策略与角色）、Deployment（AWS/GCP/Azure/Kubernetes/Docker/环境变量）、Architecture & Development（元数据模型、MCP/MCL 事件模型、开发环境、新增摄取源）、DataHub Cloud、Community、Optional（发布说明、GraphQL Schema 参考、DataHub Actions、Iceberg Catalog）。
统一链接格式：每组下均以- [标题](https://docs.datahub.com/docs/...)的 Markdown 列表形式给出，方便 LLM 解析后按需抓取正文页。

这种"索引 + 按需取页"的设计，正是为了让 AI 工具在上下文窗口有限的情况下，先加载高密度导航，再只拉取与当前问题相关的页面。

按工具快速接入（Quick Start）

DataHub 文档为不同 AI 工具给出了开箱即用的接入方式，核心思路都是把llms.txt或文档站域名作为自定义知识源交给工具。

Cursor：添加自定义文档源

打开Settings → Features → Docs；
点击+ Add new doc；
输入https://docs.datahub.com作为 URL。

Cursor 会抓取并索引整个站点，之后在对话中通过@DataHub引用该文档源即可。

Claude Code：在提示词或 CLAUDE.md 中引用索引

在提示词中直接引用索引地址，让 Claude Code 把它当作参考资料：

claude "Using https://docs.datahub.com/llms.txt as reference, how do I set up DataHub ingestion from Snowflake?"

或者把该 URL 写进项目根目录的CLAUDE.md（本仓库各子项目均维护自己的CLAUDE.md/AGENTS.md，例如 datahub-web-react/CLAUDE.md、docs-website/CLAUDE.md），这样 Claude Code 会在每一轮对话中自动携带该参考源。

Claude（Web 与桌面版）：粘贴 URL 即可

把llms.txt的 URL 直接粘贴进对话：

Use https://docs.datahub.com/llms.txt as reference. How do I write a custom ingestion source in DataHub?

Claude 会自行抓取索引及其中相关的链接页面。仓库中对应的实操文档可参见 metadata-ingestion/adding-source.md（编写自定义摄取源的完整流程）。

ChatGPT：开启联网后粘贴 URL

在开启浏览（browsing）功能的前提下，把llms.txtURL 粘贴进对话，ChatGPT 会将其作为本次会话后续内容的导航辅助，持续从中取用相关资料。

GitHub Copilot（VS Code）：使用 #fetch 命令

在 VS Code 的 Copilot Chat 中，用#fetch指令直接拉取索引内容：

#fetch https://docs.datahub.com/llms.txt explain DataHub's metadata model

配合仓库内的 metadata-models 模块（693 个.pdl模型文件）与 docs/metadata-modeling/metadata-model.md，可以进一步核对实体、Aspect 与 URN 等元数据模型的细节。

从"查文档"到"查元数据"：AI 访问你的数据上下文

接入文档只是第一层。DataHub 更进一步，为 AI 提供了访问真实元数据的能力——Agent 不仅能回答"DataHub 怎么用"，还能回答"我公司的revenue表属于谁、下游有哪些任务、有没有 PII 列"。这是通过以下四条路径实现的：

MCP Server：把 AI 客户端直连到 DataHub 实例

MCP Server 实现了 Model Context Protocol（MCP），让 AI Agent 通过自然语言直接查询 DataHub 元数据：搜索数据资产、追踪表级/列级血缘、查看 Schema、基于真实使用情况起草 SQL。适用客户端包括 Cursor、Windsurf、Claude Desktop、OpenAI 等任意 MCP 兼容客户端。

托管版（DataHub Cloud v0.3.12+）：直接指向托管端点https://<tenant>.acryl.io/mcp，用Authorization: Bearer <token>携带个人访问令牌认证；新版（v1.0.2+）支持 OAuth2 + 动态客户端注册（DCR），用户可走浏览器登录。
自托管（DataHub Core）：运行开源mcp-server-datahub，通过环境变量DATAHUB_GMS_URL（GMS 端点，如http://localhost:8080）与DATAHUB_GMS_TOKEN认证，uvx mcp-server-datahub@latest本地启动（stdio），或mcp-server-datahub-http共享部署（HTTP，每用户携带各自 token，GET /health可作健康探针）。
工具能力：只读工具如search（支持/q语法与布尔逻辑）、get_entities、list_schema_fields、get_lineage、get_dataset_queries、draft_sql_for_tables；写入工具如add_tags、add_owners、update_description、set_domains、save_document等（v0.5.0+ 通过TOOLS_IS_MUTATION_ENABLED=true开启），工具均带readOnlyHint/destructiveHint等 MCP 标准提示，便于客户端对修改类操作做二次确认。

Agent Context Kit：面向主流 Agent 框架与平台的预构建集成

Agent Context Kit 是一套"指南 + SDK + MCP 服务器"的组合，用于构建具备 DataHub 上下文（业务定义、上下文文档、所有权、血缘、质量信号、样例查询等）的 AI Agent。其覆盖的集成面包括：

AI 编码助手：Cursor、Claude（Code & Desktop）、Gemini CLI、Snowflake Cortex Code；
Agent 框架（SDK）：LangChain、Google ADK，Python 侧安装pip install datahub-agent-context（需 Python 3.10+、一个 DataHub 实例与个人访问令牌）；
托管 Agent 平台：Databricks Genie Code / Agent Bricks、Snowflake Cortex Agents、Google Vertex AI、Microsoft Copilot Studio。

文档中还给出了典型的可构建 Agent 形态：文本转 SQL 数据分析 Agent（先在 DataHub 中找到可信数据集，再生成并执行 SQL）、数据质量 Agent（发现重要表、配置断言、生成健康报告）、数据治理/数据管家 Agent（批量应用描述与合规术语并产出覆盖报告）。

Ask DataHub（Cloud）：基于元数据图与组织知识的对话式问答

Ask DataHub（托管版功能）是基于元数据图与组织知识（Context Graph 中的 runbook、策略、FAQ）回答数据问题的对话式 AI 助手。它支持：发现可信数据（结合使用模式、文档质量、所有权与质量指标）、影响分析（沿血缘定位全部下游依赖）、深入理解（谁拥有/谁在用/历史）、引用 Context Documents 与业务术语表回答策略性问题、评估数据质量、生成首稿 SQL。

Analytics Agent：开源的自然语言数据分析 Agent

Analytics Agent 是 Apache 2.0 开源、自带 LLM（BYO LLM）的 Agent：用自然语言提问 → 在 DataHub 目录中检索上下文 → 写出 SQL → 执行并渲染图表，全程工具调用与 SQL 步骤可见，并提供 1–5 分的上下文质量评分；/improve-context可生成并回写文档改进建议。快速上手：pip install datahub-analytics-agent后执行analytics-agent quickstart（本地http://localhost:8100起服务），或用 Docker 拉起预置样例数据的 DataHub 实例做端到端体验。

在仓库中进一步深入

查看 llms.txt 全文，了解索引的完整分组与链接清单；
阅读 MCP Server 指南，掌握托管端点、PAT/OAuth 认证、Claude Desktop / Claude Code / Cursor / Gemini CLI 的 JSON 或 CLI 配置片段，以及共享 HTTP 部署的注意事项（共享部署禁止设置DATAHUB_GMS_TOKEN，需开启METADATA_SERVICE_AUTH_ENABLED=true）；
阅读 Agent Context Kit 及其目录 docs/dev-guides/agent-context/ 下各平台的端到端接入指南；
在 datahub-agent-context/src/datahub_agent_context/ 查看 Agent 上下文工具的 Python 实现；
了解 docs/automations/ai-docs.md 中 Cloud 版自动生成表/列描述的 AI 文档能力，进一步完善 AI 工作流。

小结

DataHub 的 AI 就绪文档方案分为两层：文档层通过https://docs.datahub.com/llms.txt机器可读索引，让 Cursor、Claude、ChatGPT、Copilot 等工具在编辑器内直接检索准确的最新文档；元数据层则通过 MCP Server、Agent Context Kit、Ask DataHub 与 Analytics Agent，把 AI 的能力延伸到真实的数据目录——搜索资产、追溯血缘、评估质量、起草 SQL、甚至回写治理元数据。文档接入只须粘贴一个 URL，元数据接入则需要一个 DataHub 实例（Core 自托管或 Cloud）与相应的认证凭证，可按团队规模与合规要求选择合适路径。

【免费下载链接】datahubThe Context Platform for your Data and AI Stack项目地址: https://gitcode.com/GitHub_Trending/da/datahub

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考

企业官网建设流程全解析