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
Theme
Codex

Codex use case

Leve seu aplicativo para o ChatGPT

Transforme seus casos de uso em aplicativos para o ChatGPT, cada um com um objetivo específico.

Difficulty Advanced
Time horizon 1h

Crie um aplicativo para o ChatGPT que ajude o usuário a alcançar um objetivo específico. Defina as ferramentas, monte a estrutura inicial do servidor MCP e de um widget opcional, conecte o aplicativo ao ChatGPT e faça ajustes até que o fluxo principal funcione.

Best for

  • Planejar seu primeiro aplicativo para o ChatGPT com base no que o usuário quer realizar
  • Montar a estrutura inicial do servidor MCP, dos metadados das ferramentas e de um widget opcional sem complicar o projeto
  • Testar localmente com HTTPS e verificar o servidor MCP personalizado no ChatGPT em ciclos curtos

Contents

    ← All use cases

    Leve seu aplicativo para o ChatGPT

    Transforme seus casos de uso em aplicativos para o ChatGPT, cada um com um objetivo específico.

    Crie um aplicativo para o ChatGPT que ajude o usuário a alcançar um objetivo específico. Defina as ferramentas, monte a estrutura inicial do servidor MCP e de um widget opcional, conecte o aplicativo ao ChatGPT e faça ajustes até que o fluxo principal funcione.

    Advanced
    1h

    Crie um aplicativo para o ChatGPT que ajude o usuário a alcançar um objetivo específico. Defina as ferramentas, monte a estrutura inicial do servidor MCP e de um widget opcional, conecte o aplicativo ao ChatGPT e faça ajustes até que o fluxo principal funcione.

    Advanced
    1h

    Best for

    • Planejar seu primeiro aplicativo para o ChatGPT com base no que o usuário quer realizar
    • Montar a estrutura inicial do servidor MCP, dos metadados das ferramentas e de um widget opcional sem complicar o projeto
    • Testar localmente com HTTPS e verificar o servidor MCP personalizado no ChatGPT em ciclos curtos

    Skills & Plugins

    • Planeje as ferramentas, conecte os recursos MCP e siga o processo atual de desenvolvimento de aplicativos para o ChatGPT.
    • Consulte as orientações oficiais mais recentes do Apps SDK antes que o Codex escreva código ou proponha uma arquitetura.
    • Use habilidades selecionadas e o servidor MCP oficial da Vercel para consultar no Codex as orientações sobre o ecossistema da Vercel.
    Skill Why use it
    ChatGPT Apps Planeje as ferramentas, conecte os recursos MCP e siga o processo atual de desenvolvimento 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 proponha uma arquitetura.
    Vercel Use habilidades selecionadas e o servidor MCP oficial da Vercel para consultar no Codex as orientações sobre o ecossistema da Vercel.

    Starter prompt

    Use $chatgpt-apps com $openai-docs para planejar, neste repositório, um aplicativo para o ChatGPT voltado a [use case]. Requisitos: - Comece com um único objetivo que o usuário precisa alcançar. - Proponha de 3 a 5 ferramentas. Defina claramente o nome, a descrição, as entradas e as saídas de cada uma. - Indique se a primeira versão precisa de um widget ou se pode começar apenas com dados. - Dê preferência a TypeScript para o servidor MCP e a React para o widget. - Destaque os requisitos de autenticação, implantação e testes. Entregáveis: - Plano das 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, neste repositório, um aplicativo para o ChatGPT voltado a [use case]. Requisitos: - Comece com um único objetivo que o usuário precisa alcançar. - Proponha de 3 a 5 ferramentas. Defina claramente o nome, a descrição, as entradas e as saídas de cada uma. - Indique se a primeira versão precisa de um widget ou se pode começar apenas com dados. - Dê preferência a TypeScript para o servidor MCP e a React para o widget. - Destaque os requisitos de autenticação, implantação e testes. Entregáveis: - Plano das ferramentas - Estrutura de arquivos proposta - Conjunto de prompts de referência - Riscos e questões em aberto

    O que você vai criar

    Todo plugin baseado em MCP tem três partes:

    • Um servidor MCP que define as ferramentas, retorna dados, aplica as regras de acesso e indica ao ChatGPT onde encontrar os recursos da interface.
    • Um componente web opcional, exibido em um iframe do ChatGPT. Você pode criá-lo com React ou apenas com HTML, CSS e JavaScript.
    • Um modelo que usa os metadados fornecidos por você para decidir quando chamar as ferramentas do plugin.

    O Codex é mais útil quando assume as tarefas repetitivas de engenharia relacionadas a essas partes:

    • Planejar quais ferramentas oferecer e definir seus metadados.
    • Criar a estrutura inicial do servidor e do widget.
    • Configurar os scripts de execução local.
    • Implementar o controle de acesso e as mudanças necessárias para a implantação em etapas separadas.
    • Criar uma rotina de verificação que comprove o funcionamento do plugin no ChatGPT.

    Por que usar o Codex

    • Os plugins baseados em MCP têm uma divisão clara entre o servidor, a interface opcional e as chamadas de ferramentas que o modelo decide fazer.
    • O Codex responde melhor a prompts que definem uma tarefa explícita, com escopo delimitado e resultado fácil de verificar. O desenvolvimento de plugins se presta bem a esse tipo de tarefa.
    • As Habilidades e o arquivo AGENTS.md fornecem ao Codex instruções reutilizáveis e regras para orientar seu trabalho no projeto.

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

    Como usar

    Pré-requisitos

    • Comece definindo uma tarefa principal que o usuário poderá realizar, em vez de tentar levar um produto inteiro para o chat.
    • Escolha as tecnologias desde o início: TypeScript ou Python para o servidor e React ou apenas HTML, CSS e JavaScript para o widget.
    • Defina como você disponibilizará o servidor via HTTPS durante o desenvolvimento, por exemplo, com ngrok ou Cloudflare Tunnel.
    • Algumas configurações ainda usam termos antigos para a conexão com um servidor MCP. Durante os testes locais, entenda esses rótulos como referências ao servidor registrado.
    1. Escolha uma tarefa específica que o plugin deve ajudar o usuário a realizar e peça ao Codex que proponha de três a cinco ferramentas, definindo com clareza o nome, a descrição, as entradas e as saídas de cada uma.
    2. Decida se a primeira versão pode retornar apenas dados ou se precisa de um widget. Crie a estrutura inicial do servidor MCP e, se necessário, do widget seguindo os padrões do repositório antes de adicionar dependências.
    3. Execute o servidor MCP localmente com acesso via HTTPS, conecte-o ao ChatGPT usando a opção Adicionar um servidor MCP personalizado e teste-o com um pequeno conjunto de prompts diretos, indiretos e negativos.
    4. Ajuste os metadados, o gerenciamento de estado e os payloads de structuredContent e _meta até que o fluxo principal de leitura funcione de forma confiável no ChatGPT.
    5. Adicione OAuth 2.1 somente quando o acesso a dados específicos do usuário ou as operações de escrita exigirem autorização, sem complicar os fluxos anônimos ou de somente leitura.
    6. Prepare uma prévia hospedada com um endpoint /mcp estável, verifique o streaming das respostas e a hospedagem dos recursos da interface e confira a lista de verificação de lançamento antes de compartilhar ou enviar o plugin para análise.

    Sugestões de prompts

    Os prompts mais eficazes para esse fluxo de trabalho incluem os seguintes elementos:

    • Um objetivo claro: diga o que o plugin deve ajudar o usuário a fazer no ChatGPT.
    • Tecnologias bem definidas: indique se prefere TypeScript ou Python no servidor e se o widget deve usar React ou manter uma implementação leve.
    • Responsabilidades bem delimitadas: peça ao Codex que proponha ou crie um conjunto pequeno de ferramentas, cada uma com uma única função.
    • Requisitos de acesso: esclareça se a primeira versão pode permitir acesso anônimo ou se precisa de contas vinculadas e operações de escrita.
    • Acesso ao ambiente de desenvolvimento local: indique o túnel ou a opção de hospedagem que pretende usar nos testes via HTTPS no ChatGPT.
    • Etapas de verificação: diga ao Codex quais comandos executar, quais prompts testar e quais evidências apresentar.

    Evite pedir planejamento, implementação, controle de acesso, implantação, envio para análise e ajustes finais em um único prompt. Divida o trabalho em etapas menores.

    Planeje o plugin antes de criar a estrutura inicial

    Use $chatgpt-apps com $openai-docs para planejar neste repositório um plugin baseado em MCP para [use case]. Requisitos: - Comece definindo a tarefa principal que o usuário poderá realizar. - Proponha de 3 a 5 ferramentas. Defina com clareza o nome, a descrição, as entradas e as saídas de cada uma. - Recomende se a primeira versão deve incluir um widget ou se pode começar retornando apenas dados. - Dê preferência a TypeScript para o servidor MCP e a React para o widget. - Identifique os requisitos de controle de acesso, implantação e testes. Entregue: - Plano das ferramentas - Estrutura de arquivos proposta - Conjunto de prompts de referência para os testes - Riscos e questões em aberto

    Crie a estrutura da primeira versão funcional

    Use $chatgpt-apps com $openai-docs para criar a estrutura inicial da primeira versão deste plugin baseado em MCP. Tecnologias: - Servidor MCP em TypeScript - Widget em React - Build com Vite - HTTPS local via ngrok Restrições: - Limite o escopo do plugin a um fluxo de leitura e, no máximo, um fluxo de escrita. - Retorne conteúdo conciso em structuredContent para o modelo e reserve _meta para os dados de uso exclusivo do widget. - Implemente as funções que processam as chamadas de ferramentas de modo que sejam idempotentes. - Reutilize os padrões do repositório antes de adicionar dependências. Verificação: - Inicie o servidor local - Explique como conectar o servidor MCP ao ChatGPT usando a opção Adicionar um servidor MCP personalizado - Liste os prompts exatos que devem ser testados

    Adicione o controle de acesso somente depois que o fluxo principal estiver funcionando

    Use $chatgpt-apps com $openai-docs para adicionar controle de acesso ao servidor MCP deste plugin. Requisitos: - Sempre que possível, permita o acesso anônimo às ferramentas de somente leitura. - Adicione OAuth 2.1 somente para dados específicos do usuário ou operações de escrita. - Use um provedor de identidade existente, como Auth0 ou Stytch. - Documente os escopos, as verificações de token e as etapas para testar o servidor MCP personalizado no ChatGPT. Entregue: - Resumo do fluxo de controle de acesso - Alterações no servidor - Variáveis de ambiente necessárias - Plano de testes de ponta a ponta

    Prepare o plugin para implantação e revisão

    Use $chatgpt-apps com $openai-docs e @vercel para preparar uma prévia hospedada deste plugin. Requisitos: - Disponibilize o endpoint /mcp em um endereço HTTPS estável. - Mantenha o streaming de respostas no endpoint /mcp. - Hospede corretamente os recursos do widget. - Adicione uma lista de verificação de lançamento que inclua metadados, indicações de uso das ferramentas, privacidade e prompts de teste. Entregue: - Plano de implantação - URL da prévia ou etapas de hospedagem - Lista de verificação para revisão - Riscos pendentes

    Verificações antes do lançamento

    • O plugin tem um objetivo específico e fácil de entender para os usuários.
    • O conjunto de ferramentas é pequeno, e cada ferramenta tem metadados, entradas e saídas explícitos.
    • O servidor MCP funciona de ponta a ponta e retorna conteúdo conciso em structuredContent, reservando _meta para os dados de uso exclusivo do widget.
    • O widget, se necessário, é exibido corretamente no ChatGPT.
    • É possível executar a rotina de testes locais via HTTPS com o servidor MCP personalizado conectado ao ChatGPT.
    • Os testes com um pequeno conjunto de prompts diretos, indiretos e negativos passam e produzem o fluxo de conversa e os payloads das ferramentas esperados.
    • O controle de acesso foi implementado apenas onde os dados específicos do usuário ou as operações de escrita o exigem.
    • Antes de compartilhar ou enviar o plugin para análise, o plano de implantação e a revisão de lançamento contemplam metadados, indicações de uso das ferramentas, privacidade e prompts de teste.

    Erros comuns

    • Pedir ao Codex que leve o produto inteiro para o ChatGPT. Limite o pedido a uma tarefa principal do usuário, de três a cinco ferramentas e um widget de escopo restrito.
    • Começar com um prompt que pede toda a implementação de uma vez. Divida o trabalho em etapas de planejamento, criação da estrutura inicial, controle de acesso, implantação e revisão.
    • Criar a interface antes de definir o contrato das ferramentas. Planeje primeiro quais ferramentas oferecer e qual será o schema das respostas. Em seguida, crie o widget.
    • Deixar de usar a documentação oficial como fonte de fundamentação. Use $chatgpt-apps com $openai-docs para que a estrutura inicial siga as orientações atuais para plugins.
    • Deixar os metadados para o fim. Escreva as descrições das ferramentas e a documentação dos parâmetros logo no início. Depois, execute novamente um conjunto de prompts para testar essas definições.
    • Adicionar controle de acesso antes de validar o fluxo anônimo ou de somente leitura. Faça o fluxo principal de chamadas de ferramentas funcionar primeiro. Depois, adicione OAuth às ferramentas que realmente precisam dele.
    • Considerar o plugin pronto antes de testá-lo no ChatGPT. Conecte o servidor MCP personalizado ao ChatGPT, inspecione os payloads das ferramentas e verifique o fluxo real da conversa.

    Tech stack

    Need

    Framework para widgets

    Default options

    React

    Why it's needed

    Uma boa escolha para widgets que mantêm estado, especialmente quando a interface precisa de filtros, tabelas ou interações em várias etapas.

    Need

    Hospedagem

    Default options

    Vercel

    Why it's needed

    Oferece implantações rápidas, ambientes de pré-visualização e HTTPS automático, além de facilitar a hospedagem de endpoints MCP.

    Need Default options Why it's needed
    Framework para widgets React Uma boa escolha para widgets que mantêm estado, especialmente quando a interface precisa de filtros, tabelas ou interações em várias etapas.
    Hospedagem Vercel Oferece implantações rápidas, ambientes de pré-visualização e HTTPS automático, além de facilitar a hospedagem de endpoints MCP.

    Related use cases