Skip to main content

Django integration for Model Context Protocol (MCP).

Project description

Pulse Django MCP

Pulse Django MCP

Seamlessly integrate your Django application with the Model Context Protocol (MCP) using the official Python SDK for Pulse.

Django Python Versions MCP Version License

Overview

pulse_django_mcp allows you to easily expose parts of your Django application (views, functions) as Tools, Resources, and Prompts compatible with the Model Context Protocol (MCP) specification (v1.6.0).

This enables AI agents and LLMs (like Gemini, Claude, etc.) that understand MCP to interact with your Django application in a standardized way.

Note: This project was significantly developed with the assistance of an AI pair programmer (Gemini, Claude and Cursor Agent). While thoroughly tested, this collaborative approach shaped its implementation.

This library acts as a thin wrapper around the official mcp Python SDK, providing:

  • Simplified Setup: An easy way to initialize and integrate the MCP server within your Django project (FastMCP class).
  • Auto-Discovery: Automatically discover Django views and register them as MCP tools.
  • SSE Transport: Exposes the MCP server via a Server-Sent Events (SSE) endpoint compatible with MCP clients.

Key Features

  • Uses Official MCP SDK: Leverages the standard mcp package for core protocol logic.
  • FastMCP-style API: Provides a familiar decorator-based API (@mcp.tool, @mcp.resource, @mcp.prompt).
  • Django View Auto-Discovery: Automatically exposes Django views as MCP tools (configurable).
  • SSE Endpoint Integration: Easily integrates the MCP SSE transport into your Django urls.py.

Installation

# Make sure you have Python 3.10+
pip install pusle_django_mcp

This will also install the required mcp SDK and Django if you don't have them.

Add pulse_django_mcp to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ... other apps
    'pulse_django_mcp',
    # ...
]

Quick Start & Documentation

For detailed setup instructions, usage examples (registering tools, resources, prompts), auto-discovery configuration, and more, please refer to the detailed documentation:

➡️ README_MCP.md

Contributing

Contributions are welcome! Please check the contribution guidelines (if available) or open an issue/pull request.

License

Pulse Django MCP is licensed under the MIT License.

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

pulse_django_mcp-0.2.2.tar.gz (28.0 kB view details)

Uploaded Source

Built Distribution

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

pulse_django_mcp-0.2.2-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file pulse_django_mcp-0.2.2.tar.gz.

File metadata

  • Download URL: pulse_django_mcp-0.2.2.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.7 Windows/10

File hashes

Hashes for pulse_django_mcp-0.2.2.tar.gz
Algorithm Hash digest
SHA256 e1ffa944e32c53bdcad10edb06f11af2df4e773f67bd6a89e2e97fd4e4d3c7a6
MD5 103bb5a2343829cf25c15e0e5b0e27cd
BLAKE2b-256 fc4de072069d1c04c90c08cfa5c73f982cc67b6321c3f931cecd468bc930636c

See more details on using hashes here.

File details

Details for the file pulse_django_mcp-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: pulse_django_mcp-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 33.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.7 Windows/10

File hashes

Hashes for pulse_django_mcp-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4eb1f7f8c13b2e33572383b2e289bcea523feb4e57871af549cf0592117ef0b5
MD5 c1bfe98a605312a3d6b45845d9bc4323
BLAKE2b-256 affc8293746b7b3e6de051cd793d405f38f1a9e4574a6048e64999b05cae6fb4

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