Data Dictionary MCP

Data Dictionary MCP

site icon
2025.04.10 0
Python数据库文档开发工具数据库开发效率
Data Dictionary MCP 是一个基于模型上下文协议(MCP)的服务,旨在协调AI代理将数据库表转换为维基百科风格的数据字典。该项目通过AI驱动的分析和描述,自动化地将各种数据库格式转换为全面、人类可读的数据字典。
View on GitHub

Overview

基本能力

产品定位

Data Dictionary MCP 是一个自动化工具,专注于将数据库结构转换为易于理解的数据字典,适用于数据库管理和开发效率提升。

核心功能

  • 多格式支持:处理JSON、CSV和纯文本文件(计划支持更多格式)
  • AI驱动的分析:生成字段描述并识别关系
  • MCP集成:使用模型上下文协议协调AI代理
  • 模式提取:从各种格式中提取数据库模式到统一表示
  • 维基百科风格输出:以熟悉且易于访问的格式呈现数据字典

适用场景

  • 数据库文档自动化生成
  • 数据库结构分析和理解
  • 开发团队内部知识共享
  • 数据库迁移和重构

工具列表

  • 格式分析器:支持JSON、CSV和纯文本文件的解析
  • AI代理协调系统:管理和协调多个AI代理进行数据库分析和描述
  • 模式提取系统:从不同格式中提取数据库结构
  • 字典生成器:生成维基百科风格的数据字典

常见问题解答

  • 项目状态:项目正在积极开发中,详细路线图可参考文档
  • 贡献:欢迎提交Pull Request
  • 许可证:MIT许可证

使用教程

使用依赖

  • Python 3.9+
  • Git
  • pip或poetry用于依赖管理

安装教程

  1. 克隆仓库: bash git clone https://github.com/jonahkeegan/data-dictionary-mcp.git cd data-dictionary-mcp

  2. 创建虚拟环境: bash python -m venv venv source venv/bin/activate # Windows: venv\Scripts\activate

  3. 安装依赖: bash pip install -r requirements.txt

  4. 运行应用: bash python src/main.py

调试方式

  • 运行单元测试: bash python -m pytest tests/
  • 检查日志输出以调试问题

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。