Docs: make OpenAI cloud reachability requirements more visible for remote MCP usage
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 84/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- python
调研方向
从 README 中第一个 OpenAI 示例开始，并将其措辞与 tests/integration/run-vs-openai.sh 中现有的警告进行比较。添加一条简短说明，解释云托管客户端需要一个可公开访问的 MCP 服务器 URL，并链接到 docs/env/local.md、Docker 或云部署文档。完成标准是：README 在该示例附近清楚说明 localhost 的限制和对公开 URL 的要求。
由索引模型根据 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 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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
-
bot-triaged module: LrScheduler module: optimizer triaged
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
documentation glm5 llm-model
难度 2/5 1-3 小时 新手友好度 78/100
vllm-project/vllm-ascend#19062 ·
维护者通常 1 天内回复
-
author-page correction
难度 2/5 1-3 小时 新手友好度 68/100
acl-org/acl-anthology#10496 · 1 条评论 ·
维护者通常 1 天内回复
-
Issue Type: Bug Report
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 76/100
SasanLabs/VulnerableApp#836 ·
维护者通常 1 天内回复