Postman MCP Generator

Fornece ferramentas JavaScript para fazer requisições de API, geradas pelo Postman MCP Generator.

Documentação

Postman MCP Generator

Bem-vindo ao seu servidor MCP gerado! 🚀 Este projeto foi criado com o Postman MCP Generator, configurado para o modo de saída de servidor Model Context Provider (MCP). Ele fornece a você:

✅ Um servidor compatível com MCP (mcpServer.js)
✅ Ferramentas JavaScript geradas automaticamente para cada requisição de API do Postman selecionada

Vamos configurar tudo!

🚦 Começando

⚙️ Pré-requisitos

Antes de começar, certifique-se de ter:

Node.js (v18+ obrigatório, v20+ recomendado)
npm (incluído com o Node)

Aviso: se você executar com uma versão inferior do Node, o fetch não estará presente. As ferramentas usam fetch para fazer chamadas HTTP. Para contornar isso, você pode modificar as ferramentas para usar node-fetch em vez disso. Certifique-se de que node-fetch esteja instalado como dependência e então importe-o como fetch em cada arquivo de ferramenta.

📥 Instalação e Configuração

1. Instalar dependências

Execute a partir do diretório raiz do seu projeto:

npm install

🔐 Definir variáveis de ambiente das ferramentas

No arquivo .env, você verá espaços reservados para variáveis de ambiente, um para cada workspace de onde as ferramentas selecionadas provêm. Por exemplo, se você selecionou requisições de 2 workspaces, ex. Acme e Widgets, você verá dois espaços reservados:

ACME_API_KEY=
WIDGETS_API_KEY=

Atualize os valores com chaves de API reais para cada API. Essas variáveis de ambiente são usadas dentro das ferramentas geradas para definir a chave de API para cada requisição. Você pode inspecionar um arquivo no diretório tools para ver como funciona.

// environment variables are used inside of each tool file
const apiKey = process.env.ACME_API_KEY;

Ressalva: Isso pode não estar correto para todas as APIs. A lógica de geração é relativamente simples - para cada workspace, criamos uma variável de ambiente com o mesmo nome do slug do workspace, e então usamos essa variável de ambiente em cada arquivo de ferramenta que pertence àquele workspace. Se este não for o comportamento correto para a sua API escolhida, sem problema! Você pode atualizar manualmente qualquer coisa no arquivo .env ou nos arquivos de ferramenta para refletir com precisão o método de autenticação da API.

🌐 Teste o Servidor MCP com o Postman

O Servidor MCP (mcpServer.js) expõe suas ferramentas de API automatizadas para clientes compatíveis com MCP, como o Claude Desktop ou o Aplicativo Desktop do Postman. Recomendamos que você teste o servidor com o Postman primeiro e depois prossiga para usá-lo com um LLM.

O Aplicativo Desktop do Postman é a maneira mais fácil de executar e testar servidores MCP. Testar o servidor baixado primeiro é opcional, mas recomendado.

Passo 1: Baixe o aplicativo Desktop do Postman mais recente em https://www.postman.com/downloads/.

Passo 2: Leia o artigo de documentação aqui e veja como criar uma requisição MCP dentro do aplicativo Postman.

Passo 3: Defina o tipo da requisição MCP como STDIO e defina o comando como node </absolute/path/to/mcpServer.js>. Se você tiver problemas ao usar apenas node (ex. uma versão antiga está sendo usada), forneça um caminho absoluto para uma versão do node 18+. Você pode obter o caminho completo para o node executando:

which node

Para verificar a versão do node, execute:

node --version

Para obter o caminho absoluto para mcpServer.js, execute:

realpath mcpServer.js

Use o comando node seguido do caminho completo para mcpServer.js como o comando para sua nova Requisição MCP do Postman. Em seguida, clique no botão Conectar. Você deve ver uma lista de ferramentas que selecionou antes de gerar o servidor. Você pode testar se cada ferramenta funciona aqui antes de conectar o servidor MCP a um LLM.

👩‍💻 Conecte o Servidor MCP ao Claude

Você pode conectar seu servidor MCP a qualquer cliente MCP. Aqui fornecemos instruções para conectá-lo ao Claude Desktop.

Passo 1: Anote o caminho completo para o node e o mcpServer.js do passo anterior.

Passo 2: Abra o Claude Desktop → Configurações → Desenvolvedores → Editar Config e adicione um novo servidor MCP:

{
  "mcpServers": {
    "<server_name>": {
      "command": "<absolute/path/to/node>",
      "args": ["<absolute/path/to/mcpServer.js>"]
    }
  }
}

Reinicie o Claude Desktop para ativar esta alteração. Certifique-se de que o novo MCP esteja ativado e tenha um círculo verde ao lado. Se sim, você está pronto para iniciar uma sessão de chat que pode usar as ferramentas que você conectou.

Aviso: Se você não fornecer um caminho absoluto para uma versão node que seja v18+, o Claude (e outros clientes MCP) pode recorrer a outra versão node no sistema de uma versão anterior. Nesse caso, a API fetch não estará presente e as chamadas de ferramenta não funcionarão. Se isso acontecer, você pode a) instalar uma versão mais recente do node e apontar para ela no comando, ou b) importar node-fetch em cada ferramenta como fetch, certificando-se de também adicionar a dependência node-fetch ao seu package.json.

Opções Adicionais

🐳 Implantação Docker (Produção)

Para implantações em produção, você pode usar Docker:

1. Construir imagem Docker

docker build -t <your_server_name> .

2. Integração com Claude Desktop

Adicione a configuração do servidor Docker ao Claude Desktop (Configurações → Desenvolvedores → Editar Config):

{
  "mcpServers": {
    "<your_server_name>": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--env-file=.env", "<your_server_name>"]
    }
  }
}

Adicione suas variáveis de ambiente (chaves de API, etc.) dentro do arquivo .env.

O projeto vem com a seguinte configuração mínima de Docker:

FROM node:22.12-alpine AS builder

WORKDIR /app
COPY package.json package-lock.json ./
RUN npm install

COPY . .

ENTRYPOINT ["node", "mcpServer.js"]

🌐 Server-Sent Events (SSE)

Para executar o servidor com suporte a Server-Sent Events (SSE), use o sinalizador --sse:

node mcpServer.js --sse

🛠️ Comandos CLI Adicionais

Listar ferramentas

Liste descrições e parâmetros de todas as ferramentas geradas com:

node index.js tools

Exemplo:

Available Tools:

Workspace: acme-workspace
  Collection: useful-api
    list_all_customers
      Description: Retrieve a list of useful things.
      Parameters:
        - magic: The required magic power
        - limit: Number of results returned
        [...additional parameters...]

➕ Adicionando Novas Ferramentas

Estenda seu servidor MCP com mais ferramentas facilmente:

Visite Postman MCP Generator.
Escolha nova(s) requisição(ões) de API, gere um novo servidor MCP e baixe-o.
Copie a(s) nova(s) ferramenta(s) gerada(s) para a pasta tools/ do seu projeto existente.
Atualize seu arquivo tools/paths.js para incluir referências às novas ferramentas.

💬 Perguntas e Suporte

Visite a página do Postman MCP Generator para atualizações e novos recursos.

Junte-se ao canal #mcp-lab no Postman Discord para compartilhar o que você construiu e obter ajuda.