Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Docs: add a minimal Django integration example for running `openapi-mcp-sdk` alongside app agents

Abierto Apto para principiantes
  • ¿Algo no está bien?
#11 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
django, python
Área
documentation

Línea de trabajo

Lee las instrucciones de README.md para ejecutar el servidor MCP y revisa las páginas existentes en docs/ para seguir su estilo. Añade una guía concisa de integración con Django que cubra un modelo de procesos recomendado, la autenticación local con el encabezado Authorization y la alternativa ?token=, y un cliente de ejemplo; después, enlázala desde README.md. Se considerará terminado cuando la guía cubra esos criterios de aceptación y README.md incluya un enlace a ella.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

  1. Create a fresh Django project on Python 3.13.
  2. Install openapi-mcp-sdk.
  3. Try to follow the README from a Django repo where the MCP server is just one part of the system.
  4. Notice there is no concrete example for manage.py, a sidecar process, or a simple docker compose setup 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 Authorization header and ?token= fallback.
  • Include one example client, such as Codex CLI or OpenAI Responses API.
  • Link the new page from README.md.
Lenguaje dominante
Python
Estrellas
22
Forks
4
Merge medio
6 min
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de openapi/mcp-server

Todos los issues de openapi/mcp-server

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.