Português

Utilizar o Codex com o Agents SDK

Utilizar o Codex com o Agents SDK

Invoque o Codex como servidor MCP para criar fluxos de trabalho de desenvolvimento multiagente

Executar o Codex como servidor MCP

Pode executar o Codex como servidor MCP e ligá-lo a partir de outros clientes MCP (por exemplo, um agente criado com a integração MCP do OpenAI Agents SDK).

Para iniciar o Codex como servidor MCP, pode utilizar o seguinte comando:

codex mcp-server

Pode iniciar um servidor MCP do Codex com o Model Context Protocol Inspector:

npx @modelcontextprotocol/inspector codex mcp-server

Envie um pedido tools/list para ver duas ferramentas:

codex: execute uma sessão do Codex com o seguinte prompt e substituições de configuração:

Propriedade Tipo Descrição
prompt (obrigatório) string O prompt inicial do utilizador para iniciar a conversa com o Codex.
approval-policy string Política de aprovação para comandos de shell gerados pelo modelo: untrusted, on-request e never.
base-instructions string O conjunto de instruções a utilizar em vez das predefinidas.
compact-prompt string Prompt utilizado ao compactar a conversa.
config object Definições de configuração individuais que substituem as de $CODEX_HOME/config.toml.
cwd string Diretório de trabalho da sessão. Se for relativo, é resolvido em relação ao diretório atual do processo do servidor.
developer-instructions string Instruções do programador injetadas como mensagem com a função de programador.
model string Substituição opcional do nome do modelo (por exemplo, gpt-5.6-terra).
sandbox string Modo de sandbox: read-only, workspace-write ou danger-full-access.

codex-reply: continue uma sessão do Codex fornecendo o ID do thread e o prompt. A ferramenta codex-reply aceita estas propriedades:

Propriedade Tipo Descrição
prompt (obrigatório) string O prompt seguinte do utilizador para continuar a conversa com o Codex.
threadId (obrigatório) string O ID do thread a continuar.
conversationId (descontinuado) string Alias descontinuado de threadId (mantido para compatibilidade).

Utilize o threadId de structuredContent.threadId na resposta tools/call. Os prompts de aprovação (exec/patch) também incluem threadId na respetiva carga útil params.

Exemplo de carga útil de resposta:

{
  "structuredContent": {
    "threadId": "019bbb20-bff6-7130-83aa-bf45ab33250e",
    "content": "`ls -lah` (or `ls -alh`) — long listing, includes dotfiles, human-readable sizes."
  },
  "content": [
    {
      "type": "text",
      "text": "`ls -lah` (or `ls -alh`) — long listing, includes dotfiles, human-readable sizes."
    }
  ]
}

Tenha em atenção que, em geral, os clientes MCP modernos comunicam apenas "structuredContent" como resultado de uma chamada de ferramenta, quando presente, embora o servidor MCP do Codex também devolva "content" para clientes MCP mais antigos.

Criar fluxos de trabalho multiagente

O Codex CLI pode fazer muito mais do que executar tarefas pontuais. Ao expor a CLI como servidor Model Context Protocol (MCP) e orquestrá-la com o OpenAI Agents SDK, pode criar fluxos de trabalho determinísticos e passíveis de revisão, desde um único agente até um pipeline completo de entrega de software.

Este guia percorre o mesmo fluxo de trabalho apresentado no OpenAI Cookbook. Irá:

  • iniciar o Codex CLI como servidor MCP de longa duração,
  • criar um fluxo de trabalho focado, com um único agente, que produz um jogo jogável no navegador, e
  • orquestrar uma equipa multiagente com transferências, proteções e rastreios completos que poderá rever posteriormente.

Antes de começar, certifique-se de que tem:

  • o Codex CLI instalado localmente, para que o comando codex esteja disponível.
  • Python 3.10+ com pip.
  • Node.js 18+ se quiser executar o exemplo do MCP Inspector acima.
  • Uma API key da OpenAI guardada localmente. Pode criar ou gerir chaves no painel da OpenAI.

Crie um diretório de trabalho para o guia e adicione a sua API key a um ficheiro .env:

mkdir codex-workflows
cd codex-workflows
printf "OPENAI_API_KEY=sk-..." > .env

Instalar dependências

O Agents SDK gere a orquestração entre o Codex, as transferências e os rastreios. Instale as versões mais recentes dos pacotes do SDK:

python -m venv .venv
source .venv/bin/activate
pip install --upgrade openai openai-agents python-dotenv

Inicializar o Codex CLI como servidor MCP

Comece por transformar o Codex CLI num servidor MCP que o Agents SDK possa chamar. O servidor disponibiliza duas ferramentas (codex() para iniciar uma conversa e codex-reply() para continuar uma) e mantém o Codex ativo ao longo de vários turnos dos agentes.

Crie um ficheiro denominado codex_mcp.py e adicione o seguinte:

import asyncio

from agents import Agent, Runner
from agents.mcp import MCPServerStdio


async def main() -> None:
    async with MCPServerStdio(
        name="Codex CLI",
        params={
            "command": "codex",
            "args": ["mcp-server"],
        },
        client_session_timeout_seconds=360000,
    ) as codex_mcp_server:
        print("Codex MCP server started.")
        # More logic coming in the next sections.
        return


if __name__ == "__main__":
    asyncio.run(main())

Execute o script uma vez para confirmar que o Codex é iniciado com êxito:

python codex_mcp.py

O script termina depois de imprimir Codex MCP server started.. Nas secções seguintes, irá reutilizar o mesmo servidor MCP em fluxos de trabalho mais completos.

Criar um fluxo de trabalho com um único agente

Comecemos com um exemplo de âmbito limitado que utiliza o Codex MCP para fornecer um pequeno jogo para navegador. O fluxo de trabalho utiliza dois agentes:

  1. Designer de jogos: redige uma descrição do jogo.
  2. Programador de jogos: implementa o jogo chamando o Codex MCP.

Atualize codex_mcp.py com o código seguinte. Este mantém a configuração do servidor MCP acima e adiciona ambos os agentes.

import asyncio
import os

from dotenv import load_dotenv

from agents import Agent, Runner, set_default_openai_api
from agents.mcp import MCPServerStdio

load_dotenv(override=True)
set_default_openai_api(os.getenv("OPENAI_API_KEY"))


async def main() -> None:
    async with MCPServerStdio(
        name="Codex CLI",
        params={
            "command": "codex",
            "args": ["mcp-server"],
        },
        client_session_timeout_seconds=360000,
    ) as codex_mcp_server:
        developer_agent = Agent(
            name="Game Developer",
            instructions=(
                "You are an expert in building simple games using basic html + css + javascript with no dependencies. "
                "Save your work in a file called index.html in the current directory. "
                "Always call codex with \"approval-policy\": \"never\" and \"sandbox\": \"workspace-write\"."
            ),
            mcp_servers=[codex_mcp_server],
        )

        designer_agent = Agent(
            name="Game Designer",
            instructions=(
                "You are an indie game connoisseur. Come up with an idea for a single page html + css + javascript game that a developer could build in about 50 lines of code. "
                "Format your request as a 3 sentence design brief for a game developer and call the Game Developer coder with your idea."
            ),
            model="gpt-5",
            handoffs=[developer_agent],
        )

        await Runner.run(designer_agent, "Implement a fun new game!")


if __name__ == "__main__":
    asyncio.run(main())

Execute o script:

python codex_mcp.py

O Codex irá ler a descrição do designer, criar um ficheiro index.html e gravar o jogo completo no disco. Abra o ficheiro gerado num navegador para jogar. Cada execução produz um design diferente, com variações únicas no estilo de jogo e nos acabamentos.

Expandir para um fluxo de trabalho multiagente

Agora, transforme a configuração com um único agente num fluxo de trabalho orquestrado e rastreável. O sistema adiciona:

  • Gestor de projeto: cria requisitos partilhados, coordena transferências e aplica proteções.
  • Designer, Programador frontend, Programador de servidor e Responsável por testes: cada um com instruções e pastas de saída de âmbito limitado.

Crie um novo ficheiro denominado multi_agent_workflow.py:

import asyncio
import os

from dotenv import load_dotenv

from agents import (
    Agent,
    ModelSettings,
    Runner,
    WebSearchTool,
    set_default_openai_api,
)
from agents.extensions.handoff_prompt import RECOMMENDED_PROMPT_PREFIX
from agents.mcp import MCPServerStdio
from openai.types.shared import Reasoning

load_dotenv(override=True)
set_default_openai_api(os.getenv("OPENAI_API_KEY"))


async def main() -> None:
    async with MCPServerStdio(
        name="Codex CLI",
        params={"command": "codex", "args": ["mcp-server"]},
        client_session_timeout_seconds=360000,
    ) as codex_mcp_server:
        designer_agent = Agent(
            name="Designer",
            instructions=(
                f"""{RECOMMENDED_PROMPT_PREFIX}"""
                "You are the Designer.\n"
                "Your only source of truth is AGENT_TASKS.md and REQUIREMENTS.md from the Project Manager.\n"
                "Do not assume anything that is not written there.\n\n"
                "You may use the internet for additional guidance or research."
                "Deliverables (write to /design):\n"
                "- design_spec.md – a single page describing the UI/UX layout, main screens, and key visual notes as requested in AGENT_TASKS.md.\n"
                "- wireframe.md – a simple text or ASCII wireframe if specified.\n\n"
                "Keep the output short and implementation-friendly.\n"
                "When complete, handoff to the Project Manager with transfer_to_project_manager."
                "When creating files, call Codex MCP with {\"approval-policy\":\"never\",\"sandbox\":\"workspace-write\"}."
            ),
            model="gpt-5",
            tools=[WebSearchTool()],
            mcp_servers=[codex_mcp_server],
        )

        frontend_developer_agent = Agent(
            name="Frontend Developer",
            instructions=(
                f"""{RECOMMENDED_PROMPT_PREFIX}"""
                "You are the Frontend Developer.\n"
                "Read AGENT_TASKS.md and design_spec.md. Implement exactly what is described there.\n\n"
                "Deliverables (write to /frontend):\n"
                "- index.html – main page structure\n"
                "- styles.css or inline styles if specified\n"
                "- main.js or game.js if specified\n\n"
                "Follow the Designer’s DOM structure and any integration points given by the Project Manager.\n"
                "Do not add features or branding beyond the provided documents.\n\n"
                "When complete, handoff to the Project Manager with transfer_to_project_manager_agent."
                "When creating files, call Codex MCP with {\"approval-policy\":\"never\",\"sandbox\":\"workspace-write\"}."
            ),
            model="gpt-5",
            mcp_servers=[codex_mcp_server],
        )

        backend_developer_agent = Agent(
            name="Backend Developer",
            instructions=(
                f"""{RECOMMENDED_PROMPT_PREFIX}"""
                "You are the Backend Developer.\n"
                "Read AGENT_TASKS.md and REQUIREMENTS.md. Implement the backend endpoints described there.\n\n"
                "Deliverables (write to /backend):\n"
                "- package.json – include a start script if requested\n"
                "- server.js – implement the API endpoints and logic exactly as specified\n\n"
                "Keep the code as simple and readable as possible. No external database.\n\n"
                "When complete, handoff to the Project Manager with transfer_to_project_manager_agent."
                "When creating files, call Codex MCP with {\"approval-policy\":\"never\",\"sandbox\":\"workspace-write\"}."
            ),
            model="gpt-5",
            mcp_servers=[codex_mcp_server],
        )

        tester_agent = Agent(
            name="Tester",
            instructions=(
                f"""{RECOMMENDED_PROMPT_PREFIX}"""
                "You are the Tester.\n"
                "Read AGENT_TASKS.md and TEST.md. Verify that the outputs of the other roles meet the acceptance criteria.\n\n"
                "Deliverables (write to /tests):\n"
                "- TEST_PLAN.md – bullet list of manual checks or automated steps as requested\n"
                "- test.sh or a simple automated script if specified\n\n"
                "Keep it minimal and easy to run.\n\n"
                "When complete, handoff to the Project Manager with transfer_to_project_manager."
                "When creating files, call Codex MCP with {\"approval-policy\":\"never\",\"sandbox\":\"workspace-write\"}."
            ),
            model="gpt-5",
            mcp_servers=[codex_mcp_server],
        )

        project_manager_agent = Agent(
            name="Project Manager",
            instructions=(
                f"""{RECOMMENDED_PROMPT_PREFIX}"""
                """
                You are the Project Manager.

                Objective:
                Convert the input task list into three project-root files the team will execute against.

                Deliverables (write in project root):
                - REQUIREMENTS.md: concise summary of product goals, target users, key features, and constraints.
                - TEST.md: tasks with [Owner] tags (Designer, Frontend, Backend, Tester) and clear acceptance criteria.
                - AGENT_TASKS.md: one section per role containing:
                  - Project name
                  - Required deliverables (exact file names and purpose)
                  - Key technical notes and constraints

                Process:
                - Resolve ambiguities with minimal, reasonable assumptions. Be specific so each role can act without guessing.
                - Create files using Codex MCP with {"approval-policy":"never","sandbox":"workspace-write"}.
                - Do not create folders. Only create REQUIREMENTS.md, TEST.md, AGENT_TASKS.md.

                Handoffs (gated by required files):
                1) After the three files above are created, hand off to the Designer with transfer_to_designer_agent and include REQUIREMENTS.md and AGENT_TASKS.md.
                2) Wait for the Designer to produce /design/design_spec.md. Verify that file exists before proceeding.
                3) When design_spec.md exists, hand off in parallel to both:
                   - Frontend Developer with transfer_to_frontend_developer_agent (provide design_spec.md, REQUIREMENTS.md, AGENT_TASKS.md).
                   - Backend Developer with transfer_to_backend_developer_agent (provide REQUIREMENTS.md, AGENT_TASKS.md).
                4) Wait for Frontend to produce /frontend/index.html and Backend to produce /backend/server.js. Verify both files exist.
                5) When both exist, hand off to the Tester with transfer_to_tester_agent and provide all prior artifacts and outputs.
                6) Do not advance to the next handoff until the required files for that step are present. If something is missing, request the owning agent to supply it and re-check.

                PM Responsibilities:
                - Coordinate all roles, track file completion, and enforce the above gating checks.
                - Do NOT respond with status updates. Just handoff to the next agent until the project is complete.
                """
            ),
            model="gpt-5",
            model_settings=ModelSettings(
                reasoning=Reasoning(effort="medium"),
            ),
            handoffs=[designer_agent, frontend_developer_agent, backend_developer_agent, tester_agent],
            mcp_servers=[codex_mcp_server],
        )

        designer_agent.handoffs = [project_manager_agent]
        frontend_developer_agent.handoffs = [project_manager_agent]
        backend_developer_agent.handoffs = [project_manager_agent]
        tester_agent.handoffs = [project_manager_agent]

        task_list = """
Goal: Build a tiny browser game to showcase a multi-agent workflow.

High-level requirements:
- Single-screen game called "Bug Busters".
- Player clicks a moving bug to earn points.
- Game ends after 20 seconds and shows final score.
- Optional: submit score to a simple backend and display a top-10 leaderboard.

Roles:
- Designer: create a one-page UI/UX spec and basic wireframe.
- Frontend Developer: implement the page and game logic.
- Backend Developer: implement a minimal API (GET /health, GET/POST /scores).
- Tester: write a quick test plan and a simple script to verify core routes.

Constraints:
- No external database—memory storage is fine.
- Keep everything readable for beginners; no frameworks required.
- All outputs should be small files saved in clearly named folders.
"""

        result = await Runner.run(project_manager_agent, task_list, max_turns=30)
        print(result.final_output)


if __name__ == "__main__":
    asyncio.run(main())

Execute o script e observe os ficheiros gerados:

python multi_agent_workflow.py
ls -R

O agente gestor de projeto grava REQUIREMENTS.md, TEST.md e AGENT_TASKS.md e, em seguida, coordena as transferências entre os agentes de design, frontend, servidor e testes. Cada agente grava artefactos de âmbito limitado na sua própria pasta antes de devolver o controlo ao gestor de projeto.

Rastrear o fluxo de trabalho

O Codex regista automaticamente rastreios que captam todos os prompts, chamadas de ferramentas e transferências. Quando a execução multiagente terminar, abra o painel Traces para inspecionar a cronologia da execução.

O rastreio de alto nível destaca como o gestor de projeto verifica as transferências antes de avançar. Selecione cada passo para ver os prompts, as chamadas ao Codex MCP, os ficheiros gravados e as durações de execução. Estes detalhes facilitam a auditoria de cada transferência e a compreensão da evolução do fluxo de trabalho turno a turno. Estes rastreios facilitam a depuração de problemas no fluxo de trabalho, a auditoria do comportamento dos agentes e a medição do desempenho ao longo do tempo sem necessidade de instrumentação adicional.