Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Docs: make OpenAI cloud reachability requirements more visible for remote MCP usage

Aperta Adatta ai principianti
  • Qualcosa non va?
#12 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
84/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia dal primo esempio OpenAI nel README e confrontane la formulazione con l’avviso esistente in tests/integration/run-vs-openai.sh. Aggiungi una breve nota che spieghi che i client ospitati nel cloud hanno bisogno di un URL del server MCP accessibile pubblicamente e inserisci un link a docs/env/local.md, Docker o alla documentazione sul deployment nel cloud. Il lavoro è completo quando il README chiarisce, vicino a quell’esempio, la limitazione di localhost e il requisito di un URL pubblico.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

  1. Start the server locally.
  2. Configure an OpenAI Responses API request with type: "mcp" and server_url: "http://localhost:8080".
  3. 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.
Lingua principale
Python
Stelle
22
Fork
4
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openapi/mcp-server

Tutte le issue di openapi/mcp-server

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.