使用说明

项目简介

dg_agent 是一个数据治理工具,它通过实现 Model Context Protocol (MCP) 服务器,为大型语言模型 (LLM) 应用提供数据治理相关的上下文信息和功能。该项目主要关注数据模型和知识图谱的查询能力,旨在帮助 LLM 应用更好地理解和利用数据治理领域的知识。

主要功能点

  • 数据模型架构查询:支持通过自然语言或结构化方式,查询业务域、应用、数据实体及其相互关系等元数据信息。
  • Cypher 工具执行:提供 'cypher_query' 工具,允许 MCP 客户端(通常是 LLM 应用)调用执行 Cypher 查询,从而访问和检索图数据库中存储的数据治理知识。
  • 多模型支持:虽然项目主要关注数据治理 Agent 的实现,但作为 MCP 服务器,它为集成了 MCP 客户端的 LLM 应用提供后端服务,支持多种 AI 模型的集成和应用。

安装步骤

  1. 环境准备:确保您的环境中已安装 Python 3.8 或更高版本,并已安装 'pip' 包管理器。
  2. 克隆仓库:使用 Git 工具克隆 dg_agent 仓库到本地:
    git clone https://github.com/chenxinma/dg_agent
  3. 安装依赖:进入仓库根目录 'dg_agent',并使用 'pip' 安装项目依赖:
    cd dg_agent
    pip install -r requirements.txt

服务器配置

MCP 服务器是为 MCP 客户端设计的后端服务。MCP 客户端需要配置服务器的启动信息才能建立连接。以下是 dg_agent MCP 服务器的客户端配置信息示例(JSON 格式):

{
  "server_name": "data_governance",
  "command": "python",
  "args": ["src\\bot\\mcp_cypher_server.py"]
}

配置参数说明:

  • 'server_name': MCP 服务器的名称,本项目默认为 'data_governance'。
  • 'command': 启动 MCP 服务器的命令。这里指定使用 'python' 解释器。
  • 'args': 启动命令的参数列表。指定执行 'src\bot\mcp_cypher_server.py' 文件来启动 MCP 服务器。

基本使用方法

  1. 启动 MCP 服务器:在 'dg_agent' 仓库根目录下,打开终端并运行以下命令启动 MCP 服务器:

    python src/bot/mcp_cypher_server.py

    服务器成功启动后,将监听来自 MCP 客户端的请求。

  2. 配置 MCP 客户端:在您的 MCP 客户端应用中,根据上述 “服务器配置” 部分的信息进行配置,建立与 dg_agent MCP 服务器的连接。

  3. 调用 Cypher 工具:通过 MCP 客户端,您可以调用服务器提供的 'cypher_query' 工具,向服务器发送 Cypher 查询请求,以查询数据治理相关的元数据信息。例如,您可以查询特定的数据实体、业务域或应用信息。服务器会将查询结果返回给 MCP 客户端,供 LLM 应用使用。

信息

分类

数据库与文件