Data Dictionary MCP

Data Dictionary MCP

一个模型上下文协议（MCP）服务，用于协调 AI Agent，将数据库表转换为 Wikipedia 风格的数据字典。

概述

Data Dictionary MCP 项目借助 AI 驱动的分析与描述，自动将各种数据库格式转换为全面、易读的数据字典。它利用模型上下文协议（MCP）协调 AI Agent，分析、描述并验证数据库结构。

功能

• 多格式支持：处理 JSON、CSV 和纯文本文件（计划支持更多格式）
• AI 驱动的分析：生成字段描述并识别关系
• MCP 集成：使用模型上下文协议协调 AI Agent
• 架构提取：从各种格式中提取数据库架构，并转换为统一表示形式
• Wikipedia 风格的输出：以熟悉、易读的形式呈现数据字典

项目状态

此项目正在积极开发中。详情请参阅项目路线图。

开始使用

前置条件

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

安装

1. 克隆代码库：

   git clone https://github.com/jonahkeegan/data-dictionary-mcp.git
   cd data-dictionary-mcp
   

2. 创建虚拟环境：

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 运行应用：

   python src/main.py
   

项目结构

data-dictionary-mcp/
├── docs/                  # Documentation
├── src/                   # Source code
│   ├── mcp/               # MCP server components
│   ├── analyzers/         # Format analyzers
│   ├── agents/            # Agent coordination
│   └── dictionary/        # Dictionary generation
├── tests/                 # Test suite
├── memory-bank/           # Cline memory bank
├── .gitignore
├── .clinerules            # Cline rules
├── README.md
└── requirements.txt

项目路线图

里程碑 1：MCP 服务基础与格式分析器

• 实现包含基本工具定义的 MCP 服务
• 开发 JSON、CSV 和纯文本格式分析器
• 创建架构提取系统
• 为核心组件编写单元测试

里程碑 2：AI Agent 协调与字段描述

• 实现 Agent 协调系统
• 开发字段描述生成功能
• 创建任务分发与结果汇总功能
• 添加集成测试

里程碑 3：内容验证与发布

• 实现内容验证
• 开发 Wikipedia 风格的格式
• 创建导出功能
• 添加端到端测试

里程碑 4：用户界面与部署

• 开发 Web 界面
• 实现搜索功能
• 添加用户反馈系统
• 创建部署基础设施

参与贡献

欢迎贡献！请随时提交 Pull Request。

许可证

此项目为开源项目，采用 MIT License。