Skip to content

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

License

Notifications You must be signed in to change notification settings

fernando080/pulse-django-mcp

Repository files navigation

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.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages