Django Migrations MCP 服务

一个用于在分布式环境中管理 Django 迁移的 Model Context Protocol (MCP) 服务。该服务封装了 Django 的迁移命令，并将其作为 MCP 端点公开，从而可以轻松地跨多个服务管理迁移并与 CI/CD 管道集成。

特性

• 检查迁移状态（等效于 showmigrations）
• 创建带有验证的新迁移（等效于 makemigrations）
• 应用带有安全检查的迁移（等效于 migrate）
• 额外的验证和安全检查：
  • 顺序迁移顺序验证
  • 冲突检测
  • 依赖验证
  • 迁移操作的安全分析

安装

本地开发

1. 克隆仓库：

git clone https://github.com/mrrobotke/django-migrations-mcp.git
cd django-migrations-mcp

2. 安装依赖：

pip install -r requirements.txt

配置

设置以下环境变量：

export DJANGO_SETTINGS_MODULE="your_project.settings"
export MCP_SERVICE_PORT=8000  # 可选，默认为 8000

用法

运行服务

1. 直接使用 Python：

python -m migrations_mcp.service

2. 使用 Docker：

docker build -t django-migrations-mcp .
docker run -e DJANGO_SETTINGS_MODULE=your_project.settings \
          -v /path/to/your/django/project:/app/project \
          -p 8000:8000 \
          django-migrations-mcp

MCP 端点

1. 显示迁移：

from mcp import MCPClient

client = MCPClient()
migrations = await client.call("show_migrations")

2. 创建迁移：

result = await client.call("make_migrations", {
    "app_labels": ["myapp"],  # 可选
    "dry_run": True  # 可选
})

3. 应用迁移：

result = await client.call("migrate", {
    "app_label": "myapp",  # 可选
    "migration_name": "0001",  # 可选
    "fake": False,  # 可选
    "plan": True  # 可选
})

CI/CD 集成

示例 GitHub Actions 工作流程：

name: Django Migrations Check

on:
  pull_request:
    paths:
      - '*/migrations/*.py'
      - '*/models.py'

jobs:
  check-migrations:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v2
    
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.11'
    
    - name: Install dependencies
      run: |
        pip install -r requirements.txt
    
    - name: Start MCP service
      run: |
        python -m migrations_mcp.service &
    
    - name: Check migrations
      run: |
        python ci/check_migrations.py

示例 check_migrations.py 脚本：

import asyncio
from mcp import MCPClient

async def check_migrations():
    client = MCPClient()
    
    # Check current status
    migrations = await client.call("show_migrations")
    
    # Try making migrations
    result = await client.call("make_migrations", {"dry_run": True})
    if not result.success:
        print(f"Error: {result.message}")
        exit(1)
    
    print("Migration check passed!")

if __name__ == "__main__":
    asyncio.run(check_migrations())

开发

运行测试

pytest migrations_mcp/tests/

代码风格

该项目遵循 PEP 8 指南。 使用以下命令格式化您的代码：

black migrations_mcp/
isort migrations_mcp/

许可证

MIT 许可证。 有关详细信息，请参见 LICENSE 文件。

贡献

1. Fork 仓库
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

Docker 用法

该项目包含一个 docker-commands.json 文件，该文件提供了用于不同部署场景的结构化命令。 您可以直接使用这些命令，也可以在脚本中解析它们。

可用的 Docker 配置

1. Redis MCP 服务器

# 运行 Redis MCP 服务器
docker run -i --rm mcp/redis redis://host.docker.internal:6379

2. Django Migrations MCP 服务器

# 基本设置
docker run -d \
  --name django-migrations-mcp \
  -e DJANGO_SETTINGS_MODULE=your_project.settings \
  -e MCP_SERVICE_PORT=8000 \
  -v /path/to/your/django/project:/app/project \
  -p 8000:8000 \
  django-migrations-mcp

# 与 Redis 集成
docker run -d \
  --name django-migrations-mcp \
  -e DJANGO_SETTINGS_MODULE=your_project.settings \
  -e MCP_SERVICE_PORT=8000 \
  -e REDIS_URL=redis://host.docker.internal:6379 \
  -v /path/to/your/django/project:/app/project \
  -p 8000:8000 \
  --network host \
  django-migrations-mcp

3. 开发环境

# 使用 docker-compose
docker-compose up -d --build

4. 测试环境

# 在容器中运行测试
docker run --rm \
  -e DJANGO_SETTINGS_MODULE=your_project.settings \
  -e PYTHONPATH=/app \
  -v ${PWD}:/app \
  django-migrations-mcp \
  pytest

5. 生产环境

# 具有健康检查的生产设置
docker run -d \
  --name django-migrations-mcp \
  -e DJANGO_SETTINGS_MODULE=your_project.settings \
  -e MCP_SERVICE_PORT=8000 \
  -e REDIS_URL=redis://your-redis-host:6379 \
  -v /path/to/your/django/project:/app/project \
  -p 8000:8000 \
  --restart unless-stopped \
  --network your-network \
  django-migrations-mcp

以编程方式使用命令

您可以解析并以编程方式使用这些命令：

import json
import subprocess

# 加载命令
with open('docker-commands.json') as f:
    commands = json.load(f)

# 运行 Redis MCP 服务器
redis_config = commands['mcpServers']['redis']
subprocess.run([redis_config['command']] + redis_config['args'])

# 运行 Django Migrations MCP 服务器
django_config = commands['mcpServers']['djangoMigrations']
subprocess.run([django_config['command']] + django_config['args'])

网络设置

1. 开发网络

docker network create mcp-dev-network

2. 生产网络

docker network create --driver overlay --attachable mcp-prod-network

使用 MCP 工具

该服务公开了多个可以通过 curl 或任何 HTTP 客户端访问的端点：

1. 显示迁移

curl -X POST http://localhost:8000/mcp \
  -H "Content-Type: application/json" \
  -d '{"method": "show_migrations"}'

2. 创建迁移

curl -X POST http://localhost:8000/mcp \
  -H "Content-Type: application/json" \
  -d '{"method": "make_migrations", "params": {"apps": ["your_app"]}}'

3. 应用迁移

curl -X POST http://localhost:8000/mcp \
  -H "Content-Type: application/json" \
  -d '{"method": "migrate", "params": {"app": "your_app"}}'