Docs: make OpenAI cloud reachability requirements more visible for remote MCP usage
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 84/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- python
調査の方向性
READMEの最初のOpenAIの例から始め、その表現を tests/integration/run-vs-openai.sh にある既存の警告と比較してください。クラウドでホストされているクライアントには、一般からアクセス可能なMCPサーバーURLが必要であることを説明する短い注記を追加し、docs/env/local.md、Docker、またはクラウドへのデプロイに関するドキュメントへのリンクを追加してください。その例の近くで、localhostの制約と公開URLの要件がREADMEに明確に記載されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Opened by @francescobianco from local draft 02-openai-cloud-reachability-guide.md.
Summary
I tested this with OpenAI's Responses API and lost time because my MCP server was running on localhost. The integration runner already warns that OpenAI cloud cannot reach localhost, but that caveat is easy to miss in the main docs.
Reproduction
- Start the server locally.
- Configure an OpenAI Responses API request with
type: "mcp"andserver_url: "http://localhost:8080". - The model cannot call the MCP server because the server is not publicly reachable.
Expected
The README should clearly say, near the first OpenAI example, that cloud-hosted clients need a public URL such as ngrok, Cloud Run, or another reachable endpoint.
Actual
The warning exists in tests/integration/run-vs-openai.sh, but not prominently in the main usage path.
Why this is a good first issue
This is a pure documentation improvement based on behavior that already exists in the repo.
Suggested acceptance criteria
- Add a short "localhost vs public URL" note to the README.
- Link to
docs/env/local.md, Docker, or cloud deployment docs. - Reuse the same terminology already present in the OpenAI integration test script.
- 主要言語
- Python
- スター
- 22
- フォーク
- 4
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
-
Path subtraction removes repeated suffix characters instead of one suffix対応中かも @Gwerdonatus が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
joke2k/django-environ#671 ·
-
good first issue help wanted windows
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
-
test_pgbouncer deploys the server under test from Charmhub instead of the local build (track/1.31)オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
canonical/temporal-k8s-operator#195 · コメント 1 件 ·
メンテナーはふだん 4 日以内に返信
-
`burr` fails to start when the Python path has a space in it対応中かも @enekoreto が今日担当しました。 オープンstatus/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 5 日以内に返信
-
device support request
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
zigpy/zha-device-handlers#5461 ·
メンテナーはふだん 4 日以内に返信