Docs: add a first-class Codex CLI setup example using `codex mcp add`
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 78/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 tests/integration/run-vs-codex.sh và phần tích hợp trong README để tìm cách thiết lập Codex CLI đã được kiểm thử và vị trí liên kết đến trang mới. Thêm một trang trong docs/ trình bày lệnh codex mcp add, việc xuất token, dọn dẹp máy chủ tạm thời, chế độ sandbox và luồng OPENAPI_SANDBOX_TOKEN. Công việc hoàn tất khi trang được liên kết từ README và bao gồm các bước này.
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 03-codex-cli-setup-docs.md.
Summary
This repo already has a Codex integration test, but I could not find a user-facing setup guide for Codex CLI. A small copy-pasteable example would help a lot.
Reproduction
- Install
@openai/codex. - Start
openapi-mcp-sdk server. - Try to connect Codex manually.
- Discover that the best example currently lives in tests/integration/run-vs-codex.sh.
Expected
A short doc section showing:
codex mcp add <name> --url http://localhost:8080 --bearer-token-env-var OPENAPI_MCP_TOKEN- how to export the token
- how to remove the temporary server
Actual
There is no dedicated Codex setup page in docs/.
Why this is a good first issue
The implementation already exists and is tested. This is mostly extracting a polished example from the integration script.
Suggested acceptance criteria
- Add a Codex CLI setup page under
docs/. - Link it from the README integration section.
- Mention sandbox mode and the
OPENAPI_SANDBOX_TOKENflow.
- Ngôn ngữ chính
- Python
- Star
- 22
- Fork
- 4
- Merge trung bình
- 6 phút
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của openapi/mcp-server
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
openapi/mcp-server#33 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
openapi/mcp-server#29 ·
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 73/100
openapi/mcp-server#25 ·
-
Testing: add a host-agnostic smoke test checklist for OpenClaw, NanoClaw, and NemoClaw-style clientsĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
openapi/mcp-server#24 ·
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 72/100
openapi/mcp-server#21 ·
Tất cả issue của openapi/mcp-server
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
NVIDIA/flare-local-inference#90 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area/streaming comp/gateway P2 platform/telegram type/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
NousResearch/hermes-agent#144897 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
request-theme
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 66/100
LizardByte/ThemerrDB#9575 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Author Page: noshin-nawalĐang mởauthor-page correction
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
acl-org/acl-anthology#10599 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
zilliztech/memsearch#818 ·
Maintainer thường phản hồi trong vòng 1 ngày