Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
#11 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
django, python
領域
documentation

調査の方向性

README.md の MCP サーバーの実行手順を読み、docs/ 配下の既存ページを確認してスタイルを合わせてください。推奨するプロセスモデル、Authorization ヘッダーと ?token= フォールバックを使ったローカル認証、およびクライアントの例を含む簡潔な Django 統合ガイドを追加し、そのガイドへのリンクを 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

  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.
主要言語
Python
スター
22
フォーク
4
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openapi/mcp-server のほかの issue

openapi/mcp-server の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。