Docs: add a minimal Django integration example for running `openapi-mcp-sdk` alongside app agents
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 72/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Ambito
- documentation
Direzione di ricerca
Leggi le istruzioni in README.md per avviare il server MCP ed esamina le pagine esistenti in docs/ per riprenderne lo stile. Aggiungi una guida concisa all’integrazione con Django che descriva un modello di processo consigliato, l’autenticazione locale con l’header Authorization e il fallback ?token=, nonché un client di esempio; poi inserisci un link alla guida in README.md. Il lavoro è completo quando la guida copre questi criteri di accettazione e README.md contiene un link alla guida.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 22
- Fork
- 4
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openapi/mcp-server
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
openapi/mcp-server#33 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
openapi/mcp-server#29 ·
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 73/100
openapi/mcp-server#25 ·
-
Testing: add a host-agnostic smoke test checklist for OpenClaw, NanoClaw, and NemoClaw-style clientsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
openapi/mcp-server#24 ·
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
openapi/mcp-server#21 ·
Tutte le issue di openapi/mcp-server
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
-
[Bug]: Importing weave changes the process-wide localeForse già presa @himanshu748 l’ha presa oggi. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
-
UX
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
mediajunkie/piper-morgan-product#2008 · 2 commenti ·