Servidor MCP Postman API V3 | Awesome MCP Servers

Servidor MCP do Postman

Versão: v0.2.0

Um servidor MCP que fornece acesso à API do Postman. A funcionalidade é baseada na especificação oficial do OpenAPI. Para mais informações, consulte a documentação da API do Postman.

Este projeto faz parte da iniciativa Model Context Protocol (MCP) da Anthropic. Para mais informações, visite o repositório do MCP no GitHub e o anúncio no blog da Anthropic.

Pule para as instruções de instalação

postman-mcp-server - Cover Image

[!WARNING] Este projeto está atualmente em desenvolvimento ativo. Use com cautela e espere mudanças significativas.

[!NOTE] Código gerado por IA. Usei Cline v2.2.2 com Claude 3.5 Sonnet (2024-10-22). Consulte docs/README.md para obter instruções e detalhes sobre como este código foi gerado.

Visão geral
Recursos
Instalação
- Pré-requisitos
- Etapas
Uso
Documentação
- Visão geral do projeto
Justificativa
Desenvolvimento
Depuração
Outros servidores MCP
Licença

Visão geral

O Postman MCP Server é um servidor MCP baseado em TypeScript que se integra à API do Postman, fornecendo gerenciamento abrangente de coleções, ambientes e APIs do Postman.

Recursos

Coleções

Operações CRUD: Crie, recupere e atualize coleções do Postman.
Gerenciamento de pastas: Organize solicitações em pastas dentro das coleções.
Gerenciamento de solicitações: Adicione e atualize solicitações dentro das coleções.
Gerenciamento de respostas: Gerencie respostas associadas às solicitações.
Controle de versão: Faça fork, mescle e puxe alterações das coleções.
Comentários: Adicione e gerencie comentários nas coleções.

Ambientes

Gerenciar ambientes: Crie e recupere ambientes para diferentes configurações.
Operações CRUD: Suporte completo para criar, atualizar e excluir ambientes.

APIs

Gerenciamento de APIs: Crie, recupere, atualize e exclua APIs.
Suporte a esquemas: Gerencie esquemas de API com suporte a múltiplos arquivos.
Marcação: Adicione e gerencie tags para APIs.
Comentários: Adicione e gerencie comentários nas APIs.

Autenticação e Autorização

Autenticação por chave de API: Acesso seguro usando chaves de API.
Controle de acesso baseado em funções: Gerencie permissões nos níveis de workspace e coleção.
Permissões de workspace: Defina permissões específicas para workspaces.

Recursos adicionais

Rede privada de API: Gerencie elementos e pastas dentro de uma rede privada de API.
Webhooks: Crie webhooks para acionar coleções com cargas personalizadas.
Recursos empresariais: Controles avançados de funções e suporte a SCIM para ambientes empresariais.

Instalação

Instalação via npm (recomendado)

Instale o pacote globalmente:

npm install -g @postmanv3/postman-mcp-server

Ou instale localmente no seu projeto:

npm install @postmanv3/postman-mcp-server

Instalação via Smithery

Para instalar o Postman MCP Server para Claude Desktop automaticamente via Smithery:

npx -y @smithery/cli install postman-api-server --client claude

Instalação a partir do código-fonte

Se preferir compilar a partir do código-fonte:

Clone o repositório:

git clone https://github.com/PostmanV3/postman-mcp-server.git
cd postman-mcp-server

Instale as dependências:
```
npm install
# or
pnpm install
```
Compile o servidor:
```
npm run build
# or
pnpm run build
```
Execute em modo de desenvolvimento com recompilação automática:
```
npm run watch
# or
pnpm run watch
```

Uso

Configurando chaves de API

Gere sua chave de API
- Visite Configurações da conta do Postman
- Clique em "Gerar chave de API"
- Salve a chave com segurança — ela não será exibida novamente
Configure a chave de API
- Adicione a chave ao seu ambiente como POSTMAN_API_KEY
- Para Claude Desktop ou Cline, inclua-a no seu arquivo de configuração (veja os exemplos de configuração abaixo)
- Nunca envie chaves de API para o controle de versão
Verifique o acesso
- A chave de API fornece acesso a todos os recursos do Postman para os quais você tem permissão
- Teste o acesso executando uma consulta simples (por exemplo, listar workspaces)

[!NOTE] Se você estiver usando a coleção da API do Postman diretamente, armazene sua chave de API como uma variável de coleção postman-api-key.

Usando o Claude Desktop

Para usar com o Claude Desktop, adicione a configuração do servidor:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%/Claude/claude_desktop_config.json

[!IMPORTANT] Se você estiver atualizando este provedor, o Claude deve ser reiniciado para detectar alterações na API do esquema de entrada (ou seja, quando os elementos ToolDefinition do servidor MCP forem alterados). Isso ocorre porque o Claude armazena em cache as definições de ferramentas na inicialização.

Exemplo de configuração

Recomendado: usando npx (funciona com instalações globais e locais):

{
  "mcpServers": {
    "postman": {
      "command": "npx",
      "args": [
        "-y",
        "@postmanv3/postman-mcp-server"
      ],
      "env": {
        "POSTMAN_API_KEY": "CHANGEME"
      }
    }
  }
}

Alternativa: caminho direto (se instalado localmente):

{
  "mcpServers": {
    "postman": {
      "command": "node",
      "args": [
        "./node_modules/@postmanv3/postman-mcp-server/build/index.js"
      ],
      "env": {
        "POSTMAN_API_KEY": "CHANGEME"
      }
    }
  }
}

Alternativa: caminho de instalação global (caminhos típicos — encontre o seu com npm root -g):

{
  "mcpServers": {
    "postman": {
      "command": "node",
      "args": [
        "/usr/local/lib/node_modules/@postmanv3/postman-mcp-server/build/index.js"
      ],
      "env": {
        "POSTMAN_API_KEY": "CHANGEME"
      }
    }
  }
}

[!NOTE] Para encontrar o caminho do seu node_modules global, execute npm root -g e substitua o caminho acima de acordo.

[!TIP] A abordagem npx é recomendada, pois encontra automaticamente o pacote, seja instalado global ou localmente, e lida com atualizações automaticamente.

Usando o Cline

Usando o mesmo exemplo de configuração, adicione a configuração do servidor à sua configuração de servidores MCP do Cline:

Exemplo de configuração

O mesmo do Claude acima.

Usando o Zed

Ainda estou tentando fazer isso funcionar. Pela documentação do Zed, parece que precisa ser uma extensão (também este problema #21455).

Documentação

A documentação oficial da API do Postman está disponível no Workspace público do Postman.

Visão geral do projeto

Referências e resumos da API do Postman

Este projeto utiliza o modelo Claude e a extensão Cline para converter a especificação OpenAPI em código TypeScript, melhorando a segurança de tipos e a integração dentro do servidor MCP.

Este projeto no GitHub inclui documentação de Referências de API que fornece orientação detalhada sobre como utilizar a plataforma Postman programaticamente. Abrange tanto o SDK de Coleções para desenvolvimento local quanto a API do Postman para integração com a plataforma em nuvem. Os principais tópicos incluem mecanismos de autenticação, limites de taxa e documentação detalhada de todos os endpoints da API, incluindo workspaces, coleções, ambientes e muito mais. Além disso, o guia oferece pré-requisitos e instruções de início rápido para facilitar interações contínuas com a API.

O diretório docs/api/summaries contém resumos abrangentes em Markdown da API do Postman. Esses documentos descrevem endpoints da API, formatos de solicitação/resposta e detalhes de implementação essenciais para validar e garantir a funcionalidade do servidor MCP. Consulte o README de Resumos da API para obter uma visão geral da estrutura da documentação e das estratégias de implementação.

Convertendo a especificação OpenAPI em código TypeScript com Claude

Construindo o servidor MCP

Consulte a Documentação de Handlers para especificações detalhadas sobre a implementação de handlers do servidor MCP. Isso inclui formatos de URI, requisitos de prompts e padrões de manipulação de recursos. Este guia é crucial para desenvolvedores que trabalham na integração e aprimoramento das funcionalidades da API do Postman dentro do servidor MCP.

Justificativa

O wrapper MCP para ferramentas do Postman faz sentido principalmente como uma camada de interação de IA para operações complexas e de várias etapas, onde estrutura e segurança são fundamentais. No entanto, pode ser excessivamente complexo para operações simples, onde o uso direto de CLI ou API seria suficiente. O wrapper MCP fornece mais valor quando:

Operações complexas

Gerenciamento de múltiplas coleções
Coordenação de ambientes
Geração de relatórios abrangentes

Automação orientada por IA

Fluxos de trabalho de teste automatizados
Manutenção de documentação de API
Gerenciamento de ambientes

Operações sensíveis a erros

Testes críticos de API
Implantações em produção
Verificação de conformidade

Fornece menos valor para:

Operações simples

Execuções básicas de coleções
Chamadas únicas de API
Verificações rápidas de ambiente

Uso direto de CLI

Operações conduzidas por desenvolvedores
Testes locais
Iterações rápidas

Desenvolvimento

Instale as dependências:

npm install
# or
pnpm install

Compile o servidor:

npm run build
# or
pnpm run build

Para desenvolvimento com recompilação automática:

npm run watch
# or
pnpm run watch

Depuração

Como os servidores MCP se comunicam via stdio, a depuração pode ser desafiadora. Recomendamos usar o MCP Inspector, disponível como script de pacote:

npm run inspector
# or
pnpm run inspector

Documentação

O Inspector fornecerá uma URL para acessar as ferramentas de depuração no seu navegador: http://localhost:5173. Você precisará adicionar o POSTMAN_API_KEY antes de conectar. Navegue até "Ferramentas" para começar.

Outros servidores MCP

Licença

Este projeto está licenciado sob a Licença MIT. Consulte o arquivo LICENSE para obter detalhes.

Este servidor MCP é apenas para fins de pesquisa. Qualquer coleta de dados ou monitoramento será conduzida exclusivamente para fins de pesquisa de segurança.