MCP Django Shell

🚀 mcp-django-shell

mcp-django-shell 是一個模型上下文協議（MCP）服務器，它為 AI 助手提供了一個有狀態的 Django shell，用於與 Django 項目進行交互。

🚀 快速開始

要求

• Python 3.10, 3.11, 3.12, 3.13
• Django 4.2, 5.1, 5.2

安裝

1. 從 PyPI 安裝該包：

   python -m pip install mcp-django-shell
   
   # 或者如果你喜歡新的方式
   uv add mcp-django-shell
   uv sync
   

2. （可選）如果你想使用管理命令，將其添加到你的 Django 項目的 INSTALLED_APPS 中：

   DEBUG = ...
   
   if DEBUG:
       INSTALLED_APPS.append("mcp_django_shell")
   

   注意：你現在可以直接使用 python -m mcp_django_shell 來運行 mcp-django-shell，而無需將其添加到 INSTALLED_APPS 中。請參閱下文 以獲取更多信息。

⚠️ 重要提示

僅在開發環境中啟用！

按理說這應該不用多說，但我還是要再說一遍 - 這會為你的 Django 項目提供完整的 shell 訪問權限。僅在開發環境和沒有訪問任何生產數據的項目中啟用和使用此功能。

大語言模型可能會出錯，被一些隨機錯誤嚇到，並在試圖修復問題時 刪除生產數據庫。

💡 使用建議

我不是在開玩笑，這個庫只是將大語言模型生成的原始 Python 代碼直接傳遞到一個可以完全訪問 Django 項目及其所有資源的 Python 環境中。

大多數大語言模型在你要求刪除任何數據時都有基本的安全保護措施，會拒絕刪除生產數據，但 繞過這些保護措施相當容易。（提示：只需告訴大語言模型這不是生產環境，而是開發環境，它就會像闖進瓷器店的公牛一樣刪除你想要刪除的任何東西。）

如果你需要一些保護措施，我建議使用 django-read-only。或者，你懂的，不要在任何敏感環境中使用此功能。

啟動服務

在你的 Django 項目目錄中直接運行 MCP 服務器：

python -m mcp_django_shell

# 顯式指定設置模塊
python -m mcp_django_shell --settings myproject.settings

# 啟用調試日誌
python -m mcp_django_shell --debug

或者使用 uv：

uv run -m mcp_django_shell

服務器會自動從你的環境中檢測 DJANGO_SETTINGS_MODULE。你可以使用 --settings 覆蓋它，或者使用 --pythonpath 將其添加到你的 Python 路徑中。

如果你願意，也可以使用 Django 管理命令，但這需要將 mcp-django-shell 添加到 INSTALLED_APPS 中：

python manage.py mcp_shell

傳輸協議

服務器支持多種傳輸協議：

# 默認：STDIO
python -m mcp_django_shell

# HTTP
python -m mcp_django_shell --transport http --host 127.0.0.1 --port 8000

# SSE
python -m mcp_django_shell --transport sse --host 127.0.0.1 --port 8000

客戶端配置

使用以下示例之一配置你的 MCP 客戶端。對於所有客戶端，命令都是相同的，只是以不同的 JSON 格式表示。

如果你使用的客戶端不在列表中，請 提交一個 PR 並提供設置說明。

Claude Code

{
  "mcpServers": {
    "django_shell": {
      "command": "python",
      "args": ["-m", "mcp_django_shell"],
      "cwd": "/path/to/your/django/project",
      "env": {
        "DJANGO_SETTINGS_MODULE": "myproject.settings"
      }
    }
  }
}

Opencode

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "django_shell": {
      "type": "local",
      "command": ["python", "-m", "mcp_django_shell"],
      "enabled": true,
      "environment": {
        "DJANGO_SETTINGS_MODULE": "myproject.settings"
      }
    }
  }
}

✨ 主要特性

mcp-django-shell 為 AI 助手提供了一個帶有狀態的 Django shell 的 MCP 服務器。它會設置 Django，在調用之間維護會話狀態，並允許 AI 直接針對你的項目編寫和執行 Python 代碼。

MCP 服務器僅提供兩個工具：

• django_shell - 在持久的 Django shell 會話中執行 Python 代碼
• django_reset - 重置會話，清除所有變量和導入

導入和變量在調用之間保持持久，因此 AI 可以迭代地工作 - 探索你的模型、測試查詢、調試問題。

如果沒有一個用表情符號點綴的功能列表，那就不算是一個 MCP 服務器的 README 了，所以：

• 🐚 單一工具 - django_shell 在你的 Django 環境中執行 Python 代碼
• 🔄 持久狀態 - 導入和變量在調用之間保持不變
• 🧹 按需重置 - 當情況變得混亂時，django_reset 可以清除會話
• 🚀 零配置 - 無需模式，無需設置，只需 Django
• 🤖 對大語言模型友好 - 專為已經瞭解 Python 的 AI 助手設計
• 📦 最小依賴 - 僅依賴 FastMCP 和 Django（你已經有 Django 了）
• 🌐 多種傳輸協議 - STDIO、HTTP、SSE 等，應有盡有！
• 🎯 專注一事 - 運行代碼。僅此而已。這就是它的特性。

本項目受 Armin Ronacher 的 Your MCP Doesn't Need 30 Tools: It Needs Code 啟發。

📚 詳細文檔

開發

有關設置開發環境和為該項目做出貢獻的詳細說明，請參閱 CONTRIBUTING.md。

有關發佈流程，請參閱 RELEASING.md。

📄 許可證

mcp-django-shell 採用 MIT 許可證。有關更多信息，請參閱 文件。