Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#12 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
84/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với ví dụ OpenAI đầu tiên trong README và so sánh cách diễn đạt với cảnh báo hiện có trong tests/integration/run-vs-openai.sh. Thêm một ghi chú ngắn giải thích rằng các client được lưu trữ trên đám mây cần URL máy chủ MCP có thể truy cập công khai, đồng thời liên kết đến docs/env/local.md, Docker hoặc tài liệu triển khai trên đám mây. Hoàn thành khi README nêu rõ giới hạn của localhost và yêu cầu về URL công khai gần ví dụ đó.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Python
Star
22
Fork
4
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của openapi/mcp-server

Tất cả issue của openapi/mcp-server

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.