Docs: add a minimal Django integration example for running `openapi-mcp-sdk` alongside app agents
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 72/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
调研方向
阅读 README.md 中有关运行 MCP 服务器的说明，并检查 docs/ 下的现有页面以匹配其风格。添加一份简洁的 Django 集成指南，涵盖推荐的进程模型、使用 Authorization 标头和 ?token= 回退方式进行本地身份验证，以及一个客户端示例；然后在 README.md 中链接到该指南。完成条件是指南涵盖这些验收标准，且 README.md 中包含指向它的链接。
由索引模型根据 Issue 内容生成。
描述
Opened by @francescobianco from local draft 01-django-integration-example.md.
Summary
I tried using this project from a Django app where agent workflows live next to regular web endpoints. The package works as a standalone MCP server, but I could not find a small Django-oriented example showing how to:
- start the MCP server from a Django-friendly process model
- pass the Openapi bearer token safely
- point an AI client at the server from local development
This seems like a documentation gap rather than a product bug.
Reproduction
- Create a fresh Django project on Python 3.13.
- Install
openapi-mcp-sdk. - Try to follow the README from a Django repo where the MCP server is just one part of the system.
- Notice there is no concrete example for
manage.py, a sidecar process, or a simpledocker composesetup with Django + MCP.
Expected
A short guide under docs/ showing one recommended integration pattern for Django users.
Actual
The current docs explain how to run the MCP server directly, but not how to place it next to a Django app that powers agent features.
Why this is a good first issue
The server already runs independently. This is mostly about adding a concise example and linking it from the README.
Suggested acceptance criteria
- Add a new doc page with a minimal Django example.
- Cover local dev with
Authorizationheader and?token=fallback. - Include one example client, such as Codex CLI or OpenAI Responses API.
- Link the new page from README.md.
- 主要语言
- Python
- 星标
- 22
- 派生
- 4
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
openapi/mcp-server 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
openapi/mcp-server#33 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
openapi/mcp-server#29 ·
-
难度 1/5 1-3 小时 新手友好度 73/100
openapi/mcp-server#25 ·
-
Testing: add a host-agnostic smoke test checklist for OpenClaw, NanoClaw, and NemoClaw-style clients未关闭
难度 2/5 1-3 小时 新手友好度 72/100
openapi/mcp-server#24 ·
-
难度 1/5 1-3 小时 新手友好度 72/100
openapi/mcp-server#21 ·
查看 openapi/mcp-server 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
PolicyEngine/policyengine-us#10262 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
kellyjonbrazil/jc#788 ·
维护者通常 2 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
`/search.json` ignores the documented `editions.sort` parameter可能已有人在做 @PranavD2905 今天认领。 未关闭Affects: Server Good First Issue Module: Solr Needs: Triage Theme: Public APIs Theme: Search
难度 2/5 1-3 小时 新手友好度 74/100
internetarchive/openlibrary#13989 · 1 条评论 ·
维护者通常 1 天内回复
-
bug P2: misleading query
难度 2/5 1-3 小时 新手友好度 62/100
jeffknupp/association#478 ·