data-dictionary-mcp

🚀 数据字典 MCP 服务器

本项目是一个使用模型上下文协议（MCP）协调 AI 代理的服务器，它能够将数据库表转换为维基百科风格的数据字典，有效解决了数据库信息展示不直观的问题，为用户提供了易于理解的数据库结构描述。

🚀 快速开始

先决条件

• 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  # 在 Windows 上：venv\Scripts\activate
   

3. 安装依赖项：

   pip install -r requirements.txt
   

4. 运行应用程序：

   python src/main.py
   

✨ 主要特性

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

📦 安装指南

克隆仓库

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

创建虚拟环境

python -m venv venv
source venv/bin/activate  # 在 Windows 上：venv\Scripts\activate

安装依赖项

pip install -r requirements.txt

运行应用程序

python src/main.py

📚 详细文档

项目状态

该项目正在积极开发中。请参阅项目路线图了解详细信息。

项目结构

data-dictionary-mcp/
├── docs/                  # 文档
├── src/                   # 源代码
│   ├── mcp/               # MCP 服务器组件
│   ├── analyzers/         # 格式分析器
│   ├── agents/            # 代理协调
│   └── dictionary/        # 字典生成
├── tests/                 # 测试套件
├── memory-bank/           # 命令行记忆库
├── .gitignore
├── .clinerules            # Cline 规则
├── README.md
└── requirements.txt

项目路线图

第一阶段：MCP 服务器基础和格式分析器

• 实现 MCP 服务器的基础功能
• 开发 JSON、CSV 和纯文本的格式分析器
• 创建模式提取系统
• 实施核心组件的单元测试

第二阶段：AI 代理协调和字段描述

• 实现代理协调系统
• 发展现场描述生成
• 创建任务分配和结果聚合
• 添加集成测试

第三阶段：内容验证和发布

• 实现内容验证
• 开发维基百科风格格式化
• 创建导出功能
• 添加端到端测试

第四阶段：用户界面和部署

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

贡献

欢迎贡献！请随意提交拉取请求。

📄 许可证

该项目是开源的，并且在MIT License下可用。