Docs: add a first-class Codex CLI setup example using `codex mcp add`
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 78/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Empieza por tests/integration/run-vs-codex.sh y la sección de integración del README para encontrar la configuración de Codex CLI probada y dónde enlazar la nueva página. Añade una página en docs/ que cubra el comando codex mcp add, la exportación del token, la limpieza del servidor temporal, el modo sandbox y el flujo OPENAPI_SANDBOX_TOKEN. La tarea estará terminada cuando la página esté enlazada desde el README e incluya estos pasos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Python
- Estrellas
- 22
- Forks
- 4
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de openapi/mcp-server
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
openapi/mcp-server#33 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
openapi/mcp-server#29 ·
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 73/100
openapi/mcp-server#25 ·
-
Testing: add a host-agnostic smoke test checklist for OpenClaw, NanoClaw, and NemoClaw-style clientsAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
openapi/mcp-server#24 ·
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
openapi/mcp-server#21 ·
Todos los issues de openapi/mcp-server
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
noontide-co/mainbranch#1211 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[1.x Bug] run-operation --sql reports success but rolls back writes on transaction-capable adaptersAbiertotriage
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
dbt-labs/dbt#16784 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
bug settings ui
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
DewaldOosthuizen/py-tray-command-launcher#162 ·
Los mantenedores suelen responder en 1 día
-
run_all sleeps after the final job despite documenting delays between jobsPosiblemente ocupada @Gambit-Checkmate la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100