使用说明

项目简介

Django MCP Server 是一个用于将现有的 Django 应用转换为 MCP 服务器的扩展模块。它允许各种 MCP 客户端和 AI 代理通过标准协议与您的 Django 后端进行交互，获取数据和调用业务逻辑。

主要功能点

• 将 Django 应用中的业务逻辑和数据（如模型方法）注册为可通过 MCP 调用的工具。
• 在 Django 应用内部提供一个标准的 MCP 服务端点。
• 支持 Streamable HTTP 和 STDIO 等多种传输协议。
• 方便与 Claude Desktop、Google ADK 等兼容 MCP 的 AI 代理和客户端集成。

安装步骤

通过 pip 包管理器安装。在您的 Django 项目环境中运行：

pip install django-mcp-server

服务器配置

为了让 MCP 客户端连接，您需要在客户端或其配置文件中指定如何启动或连接到您的 Django MCP 服务器。

对于支持 STDIO 传输的客户端（如 Claude Desktop），配置通常是一个 JSON 对象，指定服务器名称、启动命令及其参数。例如 (请根据您的实际环境替换路径)：

{
 "mcpServers": {
  "您的服务器名称": {
   "command": "/path/to/您使用的Python解释器/python",
   "args": [
    "/path/to/您的Django项目根目录/manage.py",
    "stdio_server"
   ]
  }
 }
}

这里的 'command' 是用于启动 Django 项目的 Python 解释器路径，'args' 是传递给解释器的参数，'manage.py stdio_server' 会以 STDIO 模式启动 MCP 服务器。

对于 Streamable HTTP 传输，客户端通常只需要配置服务器的 URL 地址 (例如 'http://localhost:8000/mcp')。

基本使用方法

1. 将 'mcp_server' 添加到您 Django 项目的 'INSTALLED_APPS' 设置中。
2. 在项目的 'urls.py' 中包含 'mcp_server.urls'，通常配置一个路径如 '/mcp' 作为 MCP 端点。
3. 在您的 Django 应用目录中创建或编辑 'mcp.py' 文件。
4. 在该文件中，可以创建继承自 'mcp_server.MCPToolset' 的类，类中非下划线开头的方法将被自动注册为 MCP 工具。或者使用 '@mcp_server.mcp_server.tool()' 装饰器直接注册异步函数为工具。
5. 运行您的 Django 应用，MCP 服务器将在指定端点启动。您可以使用兼容的 MCP 客户端连接并调用定义的工具。