Drf MCP Docs

MCP开发工具

提供方 Abdulkhalek-1

开发工具 stdio · 本地进程 无需鉴权 社区 / 第三方 ClaudeCursor
查看接入方式

drf-mcp-docs通过模型上下文协议(MCP)为AI编码代理提供Django REST Framework API文档,帮助开发者编写正确的前端集成代码。

一句话选型结论

按资料字段整理

Drf MCP Docs 属于开发工具类 MCP 服务器,stdio · 本地进程,无需鉴权,可直接接入 Claude、Cursor,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式stdio · 本地进程 鉴权无需鉴权 部署方式本地部署
GitHub 星标 17 仓库热度,无公开仓库时显示未标注
工具数 7 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量7暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

API文档Python本地部署AI辅助开发DjangoRESTFramework代码生成前端集成

安装与配置

stdio · 本地进程 无需鉴权
客户端在本机拉起子进程,数据不出本机
pip install drf-mcp-docs

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js 等运行时,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 7 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 7 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude、Cursor,换客户端不用重新研究配置。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 Claude、Cursor 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Drf MCP Docs当前 7 stdio · 本地进程 本地部署 有 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方Abdulkhalek-1上游标注的维护方 Abdulkhalek-1
分类开发工具本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

7.3 KB
来自项目仓库与上游目录的原文,未做删改

drf-mcp-docs

API documentation via MCP for AI coding agents


drf mcp文档 公开Django REST框架API 文档 通过 模型上下文协议(MCP) 因此,AI编码代理可以读取、理解并帮助您编写正确的前端集成代码。

> 这与其他Django+MCP包有什么不同?
>
> 套餐如 django-mcp-server 和 django-rest-framework-mcp 暴露DRF 行动 作为MCP工具,AI代理直接调用您的端点。 drf mcp文档 根本不同:它公开了API 文档 因此,AI代理可以帮助开发人员 编写前端代码 (React、Vue、Angular等)。
>
> 把它想象成: drf survival在浏览器中为人类生成文档 → drf-mcp-docs通过mcp为AI代理生成文档.

特性

  • MCP资源 -浏览API结构:概述、端点、模式、身份验证方法
  • MCP工具 --搜索端点,获取详细文档,生成请求/响应示例
  • 代码生成 --生成具有实际类型和文档的集成代码(JS/TS:fetch、axios、ky-Python:requests、httpx--cURL)
  • 多适配器 --适用于drf壮观、drf-yasg或drf的内置模式生成
  • 零风险 --只读文档,不可能发生数据突变
  • 两次运输 --stdio用于本地AI工具,可流式传输http用于远程/网络访问

快速开始

1.安装```bash

pip install drf-mcp-docs


使用特定的模式生成器:```bash
pip install drf-mcp-docs[spectacular]   # recommended
pip install drf-mcp-docs[yasg]

2.配置

添加到Django设置中:```python
INSTALLED_APPS = [

...

'rest_framework',
'drf_mcp_docs',
]


这是基本用法。drf-mcp-docs会自动检测您的模式生成器。

### 3.跑步

**stdio传输** (适用于本地AI工具,如Claude Code、Cursor等):```bash
python manage.py runmcpserver --transport stdio

可流式HTTP传输 (用于网络访问):```bash
python manage.py runmcpserver --transport streamable-http --host 0.0.0.0 --port 8100


**检查配置** (验证设置、适配器和架构):```bash
python manage.py checkmcpconfig

4.连接您的AI工具

克劳德代码 (~/.claude.json):```json
{
"mcpServers": {
"my-api-docs": {
"command": "python",
"args": ["manage.py", "runmcpserver", "--transport", "stdio"],
"cwd": "/path/to/your/django/project"
}
}
}


**光标** (`.cursor/mcp.json`):```json
{
"mcpServers": {
"my-api-docs": {
"command": "python",
"args": ["manage.py", "runmcpserver", "--transport", "stdio"],
"cwd": "/path/to/your/django/project"
}
}
}

AI代理可以做什么

一旦连接,您的AI编码代理可以:```
You: "Show me all the product endpoints"
Agent: [reads api://endpoints resource, filters by tag]

You: "Generate a React hook to create a new product"
Agent: [calls get_endpoint_detail for POST /api/products/]
[calls get_request_example for the request body]
[calls generate_code_snippet with typescript + fetch]
→ Generates a complete, typed React hook with correct fields


### 可用资源

|资源URI|描述|
|---|---|
| `api://overview` |API标题、版本、基本URL、身份验证摘要、标记、终结点计数|
| `api://endpoints` |所有端点:路径、方法、摘要、标签(紧凑列表)|
| `api://endpoints/{method}/{path}` |一个端点的完整细节|
| `api://schemas` |所有模式/模型定义(名称+字段摘要)|
| `api://schemas/{name}` |具有属性、类型和约束的完整架构|
| `api://auth` |包含所有身份验证方法的身份验证指南|

### 可用工具

|工具|参数|说明|
|---|---|---|
| `search_endpoints` | `query`, `method?`, `tag?` |按关键字搜索端点|
| `get_endpoint_detail` | `path`, `method` |完整的端点文档|
| `get_request_example` | `path`, `method` |请求正文和参数示例|
| `get_response_example` | `path`, `method`, `status_code?` |示例响应|
| `generate_code_snippet` | `path`, `method`, `language?`, `client?` |支持分页的集成代码(JS/TS、Python、cURL)|
| `list_schemas` |--|所有数据模型名称和描述|
| `get_schema_detail` | `name` |包含所有字段和类型的完整架构|

## 配置

所有设置都是可选的。添加一个 `DRF_MCP_DOCS` dict到你的Django设置:```python
DRF_MCP_DOCS = {
# Server
'SERVER_NAME': 'my-api',                    # MCP server name (default: 'drf-mcp-docs')
'SERVER_INSTRUCTIONS': 'Custom prompt...',   # Instructions shown to AI agents

# Schema
'SCHEMA_ADAPTER': None,                      # Auto-detect, or full dotted path
'SCHEMA_PATH_PREFIX': '/api/',               # Only include endpoints under this prefix
'EXCLUDE_PATHS': ['/api/internal/'],          # Paths to exclude
'CACHE_SCHEMA': not DEBUG,                   # Cache in production, refresh in dev
'CACHE_TTL': None,                           # Schema cache TTL in seconds (None = no expiry)

# Transport
'TRANSPORT': 'streamable-http',              # Default transport: 'streamable-http' or 'stdio'
'MCP_ENDPOINT': '/mcp/',                     # URL path for HTTP transport

# Code generation
'DEFAULT_CODE_LANGUAGE': 'javascript',       # 'javascript', 'typescript', or 'python'
'DEFAULT_HTTP_CLIENT': 'fetch',              # 'fetch', 'axios', 'ky', 'requests', or 'httpx'
}

架构适配器选择

drf-mcp-docs会按照以下优先级顺序自动检测您的模式生成器:

  1. drf壮观 (推荐)--最完整的OpenAPI 3.x输出
  2. yasg博士 --Swagger 2.0自动转换为OpenAPI 3.0
  3. DRF内置 --具有有限模式细节的基本回退

要强制使用特定适配器,请执行以下操作:```python
DRF_MCP_DOCS = {
'SCHEMA_ADAPTER': 'drf_mcp_docs.adapters.spectacular.SpectacularAdapter',
}


## ASGI集成

对于使用ASGI的项目,在Django应用程序旁边挂载MCP端点:```python
# asgi.py
from django.core.asgi import get_asgi_application
from drf_mcp_docs.urls import mount_mcp

django_app = get_asgi_application()
application = mount_mcp(django_app)  # Mounts at /mcp/ by default

使用自定义路径:```python
application = mount_mcp(django_app, path="/api-docs-mcp/")


## 发展```bash
git clone https://github.com/Abdulkhalek-1/drf-mcp-docs.git
cd drf-mcp-docs
pip install -e ".[dev]"
pytest

运作原理```

┌─────────────┐ ┌──────────────┐ ┌─────────────────┐ ┌───────────┐
│ AI Agent │────>│ MCP Server │────>│ Schema Processor │────>│ Adapter │
│ (Claude, │<────│ (FastMCP) │<────│ (OpenAPI dict │<────│ (spectac- │
│ Cursor...) │ │ │ │ → structured) │ │ ular, │
└─────────────┘ └──────────────┘ └─────────────────┘ │ yasg, │
Resources + Tools Dataclasses + Search │ DRF) │
└───────────┘
```

  1. 适配器 从所选生成器中提取OpenAPI模式
  2. 处理器 将原始字典转换为结构化、人工智能友好的数据类
  3. MCP服务器 公开资源(可浏览文档)和工具(搜索、示例、代码生成)
  4. AI 代理 通过stdio或HTTP连接,读取API文档,帮助编写前端代码

许可证

MIT许可证。看 许可证 了解详情。

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Drf MCP Docs 怎么安装?

在客户端按下面的安装命令接入:pip install drf-mcp-docs。装完在客户端配置里引用同一个包或端点。

Drf MCP Docs 怎么在 Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Drf MCP Docs 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Drf MCP Docs 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

Drf MCP Docs 支持哪些客户端?

资料标注支持 Claude、Cursor;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Drf MCP Docs 能提供哪些能力?

资料显示约 7 个工具;能力标签包括 API文档、代码生成、Python、Claude、开发工具。具体工具清单以官方文档为准。

Drf MCP Docs 需要什么运行环境?

属于本地进程,需要在本机装好运行环境。

Drf MCP Docs 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。