For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal
Codex

Codex use case

Leve seu aplicativo para o ChatGPT

Transforme seus casos de uso em aplicativos específicos para o ChatGPT.

Difficulty Avançado
Time horizon 1 h

Crie, de ponta a ponta, um aplicativo do ChatGPT voltado a um resultado específico: defina as ferramentas, crie a estrutura inicial do servidor MCP e do widget opcional, conecte o aplicativo ao ChatGPT e faça ajustes até que o fluxo principal funcione.

Ideal para

  • Planejar o primeiro aplicativo do ChatGPT com foco em um resultado específico para o usuário
  • Criar a estrutura inicial de um servidor MCP, dos metadados das ferramentas e de um widget opcional, sem adicionar complexidade desnecessária
  • Manter um ciclo rápido entre os testes HTTPS locais e a verificação no modo de desenvolvedor do ChatGPT

Contents

    ← Todos os casos de uso

    Leve seu aplicativo para o ChatGPT

    Transforme seus casos de uso em aplicativos específicos para o ChatGPT.

    Crie, de ponta a ponta, um aplicativo do ChatGPT voltado a um resultado específico: defina as ferramentas, crie a estrutura inicial do servidor MCP e do widget opcional, conecte o aplicativo ao ChatGPT e faça ajustes até que o fluxo principal funcione.

    Avançado
    1 h

    Crie, de ponta a ponta, um aplicativo do ChatGPT voltado a um resultado específico: defina as ferramentas, crie a estrutura inicial do servidor MCP e do widget opcional, conecte o aplicativo ao ChatGPT e faça ajustes até que o fluxo principal funcione.

    Avançado
    1 h

    Ideal para

    • Planejar o primeiro aplicativo do ChatGPT com foco em um resultado específico para o usuário
    • Criar a estrutura inicial de um servidor MCP, dos metadados das ferramentas e de um widget opcional, sem adicionar complexidade desnecessária
    • Manter um ciclo rápido entre os testes HTTPS locais e a verificação no modo de desenvolvedor do ChatGPT

    Habilidades e Plug-ins

    • Planeje as ferramentas, integre os recursos MCP e siga o fluxo atual de criação de aplicativos para o ChatGPT.
    • Consulte as orientações oficiais mais recentes do Apps SDK antes que o Codex escreva código ou sugira uma arquitetura.
    • Integre ao Codex as orientações sobre o ecossistema da Vercel usando Habilidades selecionadas e o servidor MCP oficial da Vercel.
    Skill Why use it
    ChatGPT Apps Planeje as ferramentas, integre os recursos MCP e siga o fluxo atual de criação de aplicativos para o ChatGPT.
    OpenAI Docs Consulte as orientações oficiais mais recentes do Apps SDK antes que o Codex escreva código ou sugira uma arquitetura.
    Vercel Integre ao Codex as orientações sobre o ecossistema da Vercel usando Habilidades selecionadas e o servidor MCP oficial da Vercel.

    Prompt inicial

    Use $chatgpt-apps com $openai-docs para planejar um aplicativo do ChatGPT para [use case] neste repositório. Requisitos: - Comece com um único resultado principal para o usuário. - Proponha de 3 a 5 ferramentas e defina com clareza seus nomes, descrições, entradas e saídas. - Recomende se a v1 precisa de um widget ou se pode começar apenas com dados. - Dê preferência ao TypeScript para o servidor MCP e ao React para o widget. - Indique os requisitos de autenticação, implantação e testes. Saída: - Plano de ferramentas - Estrutura de arquivos proposta - Conjunto de prompts de referência - Riscos e questões em aberto
    Use $chatgpt-apps com $openai-docs para planejar um aplicativo do ChatGPT para [use case] neste repositório. Requisitos: - Comece com um único resultado principal para o usuário. - Proponha de 3 a 5 ferramentas e defina com clareza seus nomes, descrições, entradas e saídas. - Recomende se a v1 precisa de um widget ou se pode começar apenas com dados. - Dê preferência ao TypeScript para o servidor MCP e ao React para o widget. - Indique os requisitos de autenticação, implantação e testes. Saída: - Plano de ferramentas - Estrutura de arquivos proposta - Conjunto de prompts de referência - Riscos e questões em aberto

    O que você vai criar

    Todo plug-in com suporte de MCP é composto por três partes:

    • Um servidor MCP que define ferramentas, retorna dados, aplica as regras de autenticação e direciona o ChatGPT aos recursos de interface disponíveis.
    • Um componente Web opcional renderizado em um iframe do ChatGPT. Você pode criá-lo com React ou apenas com HTML, CSS e JavaScript.
    • Um modelo que decide quando chamar as ferramentas do plug-in com base nos metadados fornecidos.

    O Codex é mais útil quando fica responsável pelo trabalho repetitivo de engenharia relacionado a essas partes:

    • Planejar o escopo e os metadados das ferramentas.
    • Criar a estrutura inicial do servidor e do widget.
    • Configurar scripts para execução local.
    • Adicionar autenticação e alterações de implantação em etapas bem delimitadas.
    • Criar o ciclo de verificação que comprova que o plug-in funciona no ChatGPT.

    Por que o Codex é uma ótima opção

    • Os plug-ins com suporte de MCP se dividem claramente em um servidor, uma interface opcional e chamadas de ferramentas orientadas pelo modelo.
    • A criação de prompts para o Codex funciona melhor quando a tarefa é explícita, tem escopo delimitado e é simples de verificar, o que combina bem com o trabalho de criação de plug-ins.
    • As Habilidades e AGENTS.md fornecem ao Codex as instruções reutilizáveis e as regras do projeto necessárias para trabalhar com base no contexto correto.

    Para saber mais sobre como instalar e usar Habilidades, consulte nossa documentação sobre Habilidades.

    Como usar

    Pré-requisitos

    • Comece com um único resultado principal para o usuário, em vez de tentar levar um produto inteiro para o chat.
    • Escolha a stack logo no início: TypeScript ou Python para o servidor e React ou apenas HTML, CSS e JavaScript para o widget.
    • Defina como disponibilizar o acesso por HTTPS durante o desenvolvimento, por exemplo, com ngrok ou Cloudflare Tunnel.
    • Algumas configurações ainda usam termos antigos para uma conexão com um servidor MCP. Durante os testes locais, considere que esses rótulos se referem ao servidor registrado.
    1. Comece com um resultado específico para o plug-in e peça ao Codex que proponha de três a cinco ferramentas, definindo com clareza nomes, descrições, entradas e saídas.
    2. Decida se a v1 pode trabalhar apenas com dados ou se precisa de um widget. Depois, crie a estrutura inicial do servidor MCP e do widget opcional seguindo os padrões existentes no repositório antes de adicionar dependências.
    3. Execute o servidor MCP localmente e exponha-o por HTTPS, conecte-o ao ChatGPT no modo de desenvolvedor e teste-o com um pequeno conjunto de prompts diretos, indiretos e negativos.
    4. Ajuste os metadados, o gerenciamento de estado, structuredContent e os payloads de _meta até que o fluxo principal de leitura funcione de maneira confiável no ChatGPT.
    5. Adicione OAuth 2.1 somente quando dados específicos de cada usuário ou ações de gravação exigirem isso, sem complicar os fluxos anônimos ou somente leitura.
    6. Prepare uma prévia hospedada com um endpoint /mcp estável, verifique o streaming e a hospedagem dos recursos da interface e revise a lista de verificação para o lançamento antes de compartilhar ou enviar o plug-in.

    Prompts sugeridos

    Prompts eficazes para esse fluxo de trabalho têm os mesmos elementos:

    • Um resultado claro: diga o que o plug-in deve ajudar o usuário a fazer no ChatGPT.
    • Uma stack definida: diga se você quer TypeScript ou Python no servidor e se o widget deve usar React ou manter uma implementação leve.
    • Limites explícitos para as ferramentas: peça ao Codex que proponha ou crie um pequeno conjunto de ferramentas, cada uma com uma única função.
    • Expectativas de autenticação: informe se a primeira versão pode ser anônima ou se precisa de contas vinculadas e ações de gravação.
    • Uma estratégia de desenvolvimento local: mencione o túnel ou a opção de hospedagem que você pretende usar nos testes HTTPS no ChatGPT.
    • Etapas de verificação: diga ao Codex quais comandos executar, quais prompts testar e quais evidências apresentar.

    Evite usar um único prompt enorme que peça planejamento, implementação, autenticação, implantação, envio e refinamento de uma só vez. Em vez disso, divida o trabalho em etapas menores.

    Planeje o plug-in antes de criar sua estrutura inicial

    Use $chatgpt-apps com $openai-docs para planejar um plug-in com suporte de MCP para [use case] neste repositório. Requisitos: - Comece com um único resultado principal para o usuário. - Proponha de 3 a 5 ferramentas e defina com clareza seus nomes, descrições, entradas e saídas. - Recomende se a v1 precisa de um widget ou se pode começar apenas com dados. - Dê preferência ao TypeScript para o servidor MCP e ao React para o widget. - Indique os requisitos de autenticação, implantação e testes. Saída: - Plano de ferramentas - Estrutura de arquivos proposta - Conjunto de prompts de referência - Riscos e questões em aberto

    Crie a estrutura inicial da primeira versão funcional

    Use $chatgpt-apps com $openai-docs para criar a estrutura da primeira versão deste plug-in baseado em MCP. Tecnologias: - Servidor MCP em TypeScript - Widget em React - Build com Vite - HTTPS local via ngrok Restrições: - Mantenha o escopo do plug-in limitado: um fluxo de leitura e, no máximo, um fluxo de gravação. - Retorne um structuredContent conciso para o modelo e reserve os dados exclusivos do widget para _meta. - Torne os manipuladores de ferramentas idempotentes. - Reutilize os padrões existentes no repositório antes de adicionar dependências. Verificação: - Inicie o servidor local - Explique como conectar o servidor MCP no modo de desenvolvedor do ChatGPT - Liste os prompts exatos a serem testados

    Adicione autenticação somente depois que o fluxo principal funcionar

    Use $chatgpt-apps com $openai-docs para adicionar autenticação ao servidor MCP deste plug-in. Requisitos: - Mantenha as ferramentas de somente leitura acessíveis anonimamente, se possível. - Adicione OAuth 2.1 somente para dados específicos do usuário ou ações de gravação. - Use um provedor de identidade existente, como Auth0 ou Stytch. - Documente os escopos, as verificações de token e o fluxo de testes no modo de desenvolvedor. Saída: - Resumo do fluxo de autenticação - Alterações no servidor - Variáveis do ambiente necessárias - Plano de testes de ponta a ponta

    Prepare o plug-in para implantação e revisão

    Use $chatgpt-apps com $openai-docs e @vercel para preparar este plug-in para uma prévia hospedada. Requisitos: - Exponha um endpoint HTTPS estável em /mcp. - Garanta que as respostas em streaming continuem funcionando em /mcp. - Hospede corretamente os recursos do widget. - Adicione uma lista de verificação de preparação para o lançamento que abranja metadados, indicações de uso das ferramentas, privacidade e prompts de teste. Saída: - Plano de implantação - URL da prévia ou etapas de hospedagem - Lista de verificação para revisão - Riscos restantes

    Preparação para o lançamento

    • O plug-in oferece um único resultado bem delimitado que os usuários conseguem entender.
    • O conjunto de ferramentas permanece pequeno, com metadados, entradas e saídas definidos explicitamente.
    • O servidor MCP funciona de ponta a ponta e retorna um structuredContent conciso, reservando os dados exclusivos do widget para _meta.
    • O widget, se necessário, é renderizado corretamente no ChatGPT.
    • Um ciclo local de testes via HTTPS funciona no modo de desenvolvedor do ChatGPT.
    • Um pequeno conjunto de prompts diretos, indiretos e negativos passa nos testes e produz o fluxo de conversa e os payloads das ferramentas esperados.
    • A autenticação é adicionada somente quando necessária para dados específicos do usuário ou ações de gravação.
    • Um plano de implantação e uma revisão da preparação para o lançamento abrangem metadados, indicações de uso das ferramentas, privacidade e prompts de teste antes que o plug-in seja compartilhado ou enviado.

    Armadilhas comuns

    • Pedir ao Codex que adapte todo o produto ao ChatGPT. Melhor abordagem: peça que ele se concentre em um único resultado principal para o usuário, com três a cinco ferramentas e um único widget de escopo delimitado.
    • Começar com um prompt gigantesco de implementação. Melhor abordagem: divida o trabalho em etapas de planejamento, criação da estrutura, autenticação, implantação e revisão.
    • Criar a interface antes que o contrato das ferramentas esteja claro. Melhor abordagem: planeje primeiro o conjunto de ferramentas e o schema de resposta; depois, crie o widget.
    • Deixar de usar a documentação oficial como fundamentação. Melhor abordagem: combine $chatgpt-apps com $openai-docs para que a estrutura gerada siga as orientações atuais para plug-ins.
    • Deixar os metadados para depois. Melhor abordagem: escreva logo no início as descrições das ferramentas e a documentação dos parâmetros; depois, teste-as executando novamente um conjunto de prompts.
    • Adicionar autenticação antes de validar o fluxo anônimo ou de somente leitura. Melhor abordagem: primeiro, faça o fluxo principal das ferramentas funcionar; depois, adicione OAuth às ferramentas que realmente precisam dele.
    • Declarar que o plug-in está concluído antes de testá-lo no ChatGPT. Melhor abordagem: conecte o servidor MCP no modo de desenvolvedor, inspecione os payloads das ferramentas e verifique o fluxo real da conversa.

    Tech stack

    Need

    Framework de widget

    Default options

    React

    Why it's needed

    Uma excelente opção padrão para widgets com estado, principalmente quando a interface precisa de filtros, tabelas ou interação em várias etapas.

    Need

    Hospedagem

    Default options

    Vercel

    Why it's needed

    Implantações rápidas, ambientes de prévia, HTTPS automático e uma forma clara de disponibilizar endpoints MCP hospedados.

    Need Default options Why it's needed
    Framework de widget React Uma excelente opção padrão para widgets com estado, principalmente quando a interface precisa de filtros, tabelas ou interação em várias etapas.
    Hospedagem Vercel Implantações rápidas, ambientes de prévia, HTTPS automático e uma forma clara de disponibilizar endpoints MCP hospedados.

    Casos de uso relacionados