Skip to main content

Full MCP server implementation for Django. Expose tools and resources via the Model Context Protocol.

Project description

mcp-django-server

Full MCP (Model Context Protocol) server implementation for Django. Expose tools and resources to AI agents with simple decorators.

Features

  • 🚀 Simple decorators - @mcp_tool, @mcp_resource, @mcp_prompt
  • 🔄 Auto-discovery - Automatically finds mcp_tools.py in all Django apps
  • 📝 Type-safe - Generates JSON Schema from Python type hints
  • 🎯 MCP compliant - Full JSON-RPC 2.0 implementation (spec 2025-06-18)
  • 🔧 Zero config - Works out of the box

Installation

pip install mcp-django-server

Quick Start

1. Add to INSTALLED_APPS

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

# Optional configuration
MCP_SERVER_NAME = "My Django MCP Server"
MCP_SERVER_VERSION = "1.0.0"

2. Include URLs

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

urlpatterns = [
    ...
    path('', include('mcp_server.urls')),
]

3. Create tools

Create mcp_tools.py in any Django app:

# myapp/mcp_tools.py
from mcp_server import mcp_tool, mcp_resource
from .models import Product

@mcp_tool(
    name="search_products",
    description="Search products by name and category"
)
def search_products(query: str, category: str = None, limit: int = 10):
    """Search products - automatically exposed via /mcp/ endpoint."""
    qs = Product.objects.filter(name__icontains=query)
    if category:
        qs = qs.filter(category=category)
    return [
        {"id": p.id, "name": p.name, "price": str(p.price)}
        for p in qs[:limit]
    ]

@mcp_resource(
    uri="catalog://products/{id}",
    name="Product",
    description="Full product details",
    mime_type="application/json"
)
def get_product(id: int):
    """Get product by ID - exposed as MCP resource."""
    p = Product.objects.get(pk=id)
    return {
        "id": p.id,
        "name": p.name,
        "description": p.description,
        "price": str(p.price)
    }

4. Test it

# Initialize
curl -X POST http://localhost:8000/mcp/ \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","clientInfo":{"name":"test"}}}'

# List tools
curl -X POST http://localhost:8000/mcp/ \
  -d '{"jsonrpc":"2.0","id":2,"method":"tools/list","params":{}}'

# Call tool
curl -X POST http://localhost:8000/mcp/ \
  -d '{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"search_products","arguments":{"query":"laptop"}}}'

API Reference

@mcp_tool

Register a function as an MCP tool.

@mcp_tool(name="tool_name", description="Tool description")
def my_tool(param1: str, param2: int = 10):
    return {"result": "value"}

Parameters:

  • name (str, optional): Tool name. Defaults to function name.
  • description (str): Tool description for AI agents.

Type Hints:

  • Function type hints are automatically converted to JSON Schema
  • Supported types: str, int, float, bool, list, dict
  • Parameters without defaults are marked as required

@mcp_resource

Register a function as an MCP resource.

@mcp_resource(
    uri="catalog://items/{id}",
    name="Item",
    description="Item details",
    mime_type="application/json"
)
def get_item(id: int):
    return {"id": id, "data": "..."}

Parameters:

  • uri (str): Resource URI template with {param} placeholders
  • name (str, optional): Resource name. Defaults to function name.
  • description (str): Resource description
  • mime_type (str): MIME type. Default: "application/json"

@mcp_prompt

Register a function as an MCP prompt template.

@mcp_prompt(
    name="analyze",
    description="Analyze data",
    arguments=[
        {"name": "data_id", "description": "Data ID", "required": True}
    ]
)
def analyze_prompt(data_id: int):
    return f"Analyze data with ID: {data_id}"

MCP Endpoints

Once installed, your Django app exposes:

  • POST /mcp/ - Main MCP JSON-RPC 2.0 endpoint

Supported methods:

  • initialize - Initialize MCP session
  • tools/list - List all registered tools
  • tools/call - Execute a tool
  • resources/list - List all resources
  • resources/read - Read a resource
  • prompts/list - List all prompts
  • prompts/get - Get a prompt

Integration with django-mcp-discovery

If you have django-mcp-discovery installed, this package automatically updates the /.well-known/mcp-server manifest with registered tools.

Examples

Django ORM Tool

@mcp_tool(description="Get user by email")
def get_user(email: str):
    from django.contrib.auth import get_user_model
    User = get_user_model()
    user = User.objects.get(email=email)
    return {
        "id": user.id,
        "email": user.email,
        "name": user.get_full_name()
    }

External API Tool

@mcp_tool(description="Get weather forecast")
def get_weather(city: str):
    import requests
    response = requests.get(f"https://api.weather.com/{city}")
    return response.json()

File Resource

@mcp_resource(
    uri="files://{path}",
    description="Read file content",
    mime_type="text/plain"
)
def read_file(path: str):
    with open(path, 'r') as f:
        return f.read()

License

MIT

Links

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_server-0.2.0.tar.gz (9.9 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_server-0.2.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file mcp_django_server-0.2.0.tar.gz.

File metadata

  • Download URL: mcp_django_server-0.2.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for mcp_django_server-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a31b087ebc8de91035c569ba9afe0431aac15a0a6106cdaeb92afd9db3fa0d08
MD5 d8c137a25ae889b47fd3a48b29d6c3f2
BLAKE2b-256 1287086d0addbbf241dafa82f7acd06a1b9dd034aa8d8f5014a81ceca4f274c5

See more details on using hashes here.

File details

Details for the file mcp_django_server-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_django_server-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d70d3423eba7e218e25eea10a7a1f73824e1500c113f66d81d41952906e54fe9
MD5 c5dbfc90932c3c55426b87fe778a0ac9
BLAKE2b-256 cd5ecd49a1ad08efe35d1dc9480bf8658a2ada55a59c8f766cbe52f0ca92d283

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