Skip to main content

MCP server providing a stateful Django shell for AI assistants.

Project description

mcp-django-shell

PyPI PyPI - Python Version Django Version

A Model Context Protocol (MCP) server providing a stateful Django shell for AI assistants to interact with Django projects.

Requirements

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

Installation

  1. Install the package from PyPI.

    python -m pip install mcp-django-shell
    
    # or if you like the new hotness
    
    uv add mcp-django-shell
    uv sync
    
  2. (Optional) Add to your Django project's INSTALLED_APPS if you want to use the management command:

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

    Note: You can now run mcp-django-shell without adding it to INSTALLED_APPS by using python -m mcp_django_shell directly. See below for more info.

[!WARNING]

Only enable in development!

Look, it should go without saying, but I will say it anyway - this gives full shell access to your Django project. Only enable and use this in development and in a project that does not have access to any production data. LLMs can go off the rails, get spooked by some random error, and in trying to fix things drop a production database.

Getting Started

Run the MCP server directly from your Django project directory:

python -m mcp_django_shell

# With explicit settings module
python -m mcp_django_shell --settings myproject.settings

# With debug logging
python -m mcp_django_shell --debug

Or using uv:

uv run -m mcp_django_shell

The server automatically detects DJANGO_SETTINGS_MODULE from your environment. You can override it with --settings or add to your Python path with --pythonpath.

There's also a Django management command if you prefer, but that requires adding mcp-django-shell to INSTALLED_APPS:

python manage.py mcp_shell

Client Configuration

Configure your MCP client using one of the examples below. The command is the same for all clients, just expressed in annoyingly different JSON soup.

Don't see your client? Submit a PR with setup instructions.

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"
      }
    }
  }
}

Usage

mcp-django-shell provides an MCP server with a stateful Django shell for AI assistants. It sets up Django, maintains session state between calls, and lets the AI write and execute Python code directly against your project.

The MCP server comes with just two tools:

  • django_shell - Execute Python code in a persistent Django shell session
  • django_reset - Reset the session, clearing all variables and imports

Imports and variables persist between calls, so the AI can work iteratively - exploring your models, testing queries, debugging issues.

It wouldn't be an MCP server README without a gratuitous list of features punctuated by emojis, so:

  • 🐚 One tool - django_shell executes Python code in your Django environment
  • 🔄 Persistent state - Imports and variables stick around between calls
  • 🧹 Reset when needed - django_reset clears the session when things get weird
  • 🚀 Zero configuration - No schemas, no settings, just Django
  • 🤖 LLM-friendly - Designed for AI assistants that already know Python
  • 📦 Minimal dependencies - Just FastMCP and Django (you already have Django)
  • 🎯 Does one thing well - Runs code. That's it. That's the feature.

Inspired by Armin Ronacher's Your MCP Doesn't Need 30 Tools: It Needs Code.

Development

For detailed instructions on setting up a development environment and contributing to this project, see CONTRIBUTING.md.

For release procedures, see RELEASING.md.

License

mcp-django-shell is licensed under the MIT license. See the LICENSE file for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_django_shell-0.4.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_django_shell-0.4.0-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file mcp_django_shell-0.4.0.tar.gz.

File metadata

  • Download URL: mcp_django_shell-0.4.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.12

File hashes

Hashes for mcp_django_shell-0.4.0.tar.gz
Algorithm Hash digest
SHA256 862bd51425872596ccbe3b2faa8b32c29d9ea5bdbd556992ccc0b3c7868c816f
MD5 6446768ac856615515bb340510d04d85
BLAKE2b-256 0a421be9b49df7e05a3dc9c5b0dba8800b2e5b11cefba1cdc21968f036d2bacb

See more details on using hashes here.

File details

Details for the file mcp_django_shell-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_django_shell-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6034bdd514f69f5ad5f459939da017ca9cf4eaa4b5c2585ba6eab594f2fcc0b
MD5 bb4c63658b0dda9b95dab6e28c8907cb
BLAKE2b-256 01b2d55082fc5f072fc6d6ee9780cabc9a7d4faa00da62a59d623347f992fa9f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page