Skip to main content

Django admin MCP integration - expose Django admin models to MCP clients

Project description

django-admin-mcp

PyPI version Python versions Django versions Tests codecov Ruff License Documentation

Expose Django admin models to MCP (Model Context Protocol) clients via HTTP. Add a mixin to your ModelAdmin classes and get instant access to CRUD operations, admin actions, model history, and more.

Features

  • Zero dependencies beyond Django and Pydantic
  • Token authentication - secure Bearer token auth with configurable expiry
  • Django admin permissions - respects existing view/add/change/delete permissions
  • Full CRUD - list, get, create, update, delete operations
  • Admin actions - execute registered Django admin actions
  • Bulk operations - update or delete multiple records at once
  • Model introspection - describe model fields and relationships
  • Related objects - traverse foreign keys and reverse relations
  • Change history - access Django admin's history log
  • Autocomplete - search suggestions for foreign key fields

Installation

pip install django-admin-mcp

Add to your Django project:

# settings.py
INSTALLED_APPS = [
    'django_admin_mcp',
    # ...
]

# urls.py
from django.urls import path, include

urlpatterns = [
    path('mcp/', include('django_admin_mcp.urls')),
    # ...
]

Run migrations to create the token model:

python manage.py migrate django_admin_mcp

Quick Start

1. Expose your models

Add the mixin to any ModelAdmin. Set mcp_expose = True to expose direct tools:

from django.contrib import admin
from django_admin_mcp import MCPAdminMixin
from .models import Article, Author

@admin.register(Article)
class ArticleAdmin(MCPAdminMixin, admin.ModelAdmin):
    mcp_expose = True  # Exposes list_article, get_article, etc.
    list_display = ['title', 'author', 'published']

@admin.register(Author)
class AuthorAdmin(MCPAdminMixin, admin.ModelAdmin):
    pass  # Discoverable via find_models, no direct tools

2. Create an API token

Go to Django admin at /admin/django_admin_mcp/mcptoken/ and create a token. Tokens can optionally be tied to users, groups, or have direct permissions assigned.

3. Configure Claude Code

Add to your Claude Code MCP settings (~/.claude/claude_desktop_config.json or project .mcp.json):

{
  "mcpServers": {
    "django-admin": {
      "url": "http://localhost:8000/mcp/",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

4. Use with Claude

Once configured, Claude can use the tools directly:

User: What models are available in Django admin?
Claude: [calls find_models tool]

User: Show me the latest 10 articles
Claude: [calls list_article with limit=10]

User: Get article #42 and update its title to "New Title"
Claude: [calls get_article with id=42, then update_article]

Available Tools

For each exposed model (e.g., Article), the following tools are generated:

CRUD Operations

Tool Description
list_article List all articles with pagination (limit, offset) and filtering
get_article Get a single article by id
create_article Create a new article with field values
update_article Update an existing article by id
delete_article Delete an article by id

Model Introspection

Tool Description
find_models Discover all exposed models and their available tools
describe_article Get field definitions, types, and constraints

Admin Actions

Tool Description
actions_article List available admin actions for the model
action_article Execute an admin action on selected records
bulk_article Bulk update or delete multiple records

Relationships

Tool Description
related_article Get related objects via foreign keys
history_article View Django admin change history
autocomplete_article Search suggestions for autocomplete fields

HTTP Protocol Reference

For custom integrations, the MCP endpoint accepts POST requests:

# List available tools
curl -X POST http://localhost:8000/mcp/ \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"method": "tools/list"}'

# Call a tool
curl -X POST http://localhost:8000/mcp/ \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"method": "tools/call", "name": "list_article", "arguments": {"limit": 10}}'

Example Conversations

CRUD Operations

User: Create a new article titled "Getting Started with Django"

Claude: I'll create that article for you.
[calls create_article with title="Getting Started with Django"]
Created article #15: "Getting Started with Django"

User: Update article 15 to add content

Claude: [calls update_article with id=15, content="..."]
Updated article #15 successfully.

User: Delete article 15

Claude: [calls delete_article with id=15]
Deleted article #15.

Admin Actions

User: Mark articles 1, 2, and 3 as published

Claude: [calls action_article with action="mark_as_published", ids=[1,2,3]]
Marked 3 articles as published.

Bulk Operations

User: Set status to "archived" for articles 10-15

Claude: [calls bulk_article with operation="update", ids=[10,11,12,13,14,15], data={"status": "archived"}]
Updated 6 articles.

User: Delete all draft articles from last month

Claude: [calls list_article to find drafts, then bulk_article with operation="delete"]
Deleted 12 draft articles.

Exploring Relationships

User: Show me all comments on article 42

Claude: [calls related_article with id=42, relation="comments"]
Found 8 comments on article #42...

User: What changes were made to article 42?

Claude: [calls history_article with id=42]
Change history for article #42:
- 2024-01-15: Changed title (admin)
- 2024-01-10: Created (admin)

Model Discovery

User: What can I manage through MCP?

Claude: [calls find_models]
Available models:
- article (5 tools: list, get, create, update, delete)
- author (5 tools: list, get, create, update, delete)
- category (5 tools: list, get, create, update, delete)

User: What fields does article have?

Claude: [calls describe_article]
Article fields:
- id (AutoField, read-only)
- title (CharField, max_length=200, required)
- content (TextField, optional)
- author (ForeignKey to Author, required)
- published (BooleanField, default=False)
- created_at (DateTimeField, auto)

Security

Two-Level Exposure

Models with MCPAdminMixin are automatically discoverable via the find_models tool, allowing Claude to see what's available. To expose full CRUD tools directly, set mcp_expose = True:

# Discoverable via find_models only
class AuthorAdmin(MCPAdminMixin, admin.ModelAdmin):
    pass

# Full tools exposed (list_article, get_article, etc.)
class ArticleAdmin(MCPAdminMixin, admin.ModelAdmin):
    mcp_expose = True

Token Authentication

  • Tokens are created in Django admin
  • Tokens can be associated with a user, groups, or have direct permissions
  • Tokens without any permissions have no access (principle of least privilege)
  • Token expiry is configurable (default: 90 days)
  • Revoke tokens by deleting them in admin

Permission Checking

All operations respect Django admin permissions:

  • list_* and get_* require view permission
  • create_* requires add permission
  • update_* requires change permission
  • delete_* requires delete permission

If a user lacks permission, the operation returns an error.

Requirements

  • Python >= 3.10
  • Django >= 3.2
  • Pydantic >= 2.0

Supported Django Versions

  • Django 3.2
  • Django 4.0
  • Django 4.1
  • Django 4.2
  • Django 5.0

License

GPL-3.0-or-later

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

django_admin_mcp-0.2.1.tar.gz (52.0 kB view details)

Uploaded Source

Built Distribution

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

django_admin_mcp-0.2.1-py3-none-any.whl (53.9 kB view details)

Uploaded Python 3

File details

Details for the file django_admin_mcp-0.2.1.tar.gz.

File metadata

  • Download URL: django_admin_mcp-0.2.1.tar.gz
  • Upload date:
  • Size: 52.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_admin_mcp-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cdfb5440a623dbb0731d88c42c8512d249b7433257750cc1724c68b37feebf41
MD5 0d8daee51f5fa232a88dac173f45c43c
BLAKE2b-256 f287faa3af9738aedf46cbf70c38de116cc823f41507474b041767a2b81b22bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_admin_mcp-0.2.1.tar.gz:

Publisher: publish.yml on 7tg/django-admin-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_admin_mcp-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_admin_mcp-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d24d749537d42ecc69f7a884c7be291423a2525e30044113296d021f9f76ebe1
MD5 7f08cd231b7834560638215ea2fa94ed
BLAKE2b-256 701b9356c387b1ddd2ea07d9395c87b518983b78bbc183bda84735c108af7dc5

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_admin_mcp-0.2.1-py3-none-any.whl:

Publisher: publish.yml on 7tg/django-admin-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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