Postman MCP Server

Interaja com a API do Postman por meio de um servidor MCP. Requer uma chave de API do Postman.

GitHub
160
Experimente este MCPPatrocinado

Documentação

Postman MCP Server

smithery badge Versão: v0.2.0

Um servidor MCP que fornece acesso à API do Postman. A funcionalidade é baseada na especificação oficial 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 MCP no GitHub e o anúncio no blog da Anthropic.

Pular 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.

postman-mcp-server MCP server

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: Criar, recuperar, atualizar e excluir coleções do Postman.
  • Gerenciamento de pastas: Organize solicitações em pastas dentro das coleções.
  • Gerenciamento de solicitações: Adicione, atualize e exclua solicitações dentro das coleções.
  • Gerenciamento de respostas: Gerencie respostas associadas às solicitações.
  • Controle de versão: Faça fork, merge e pull de alterações nas 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 payloads personalizados.
  • Recursos empresariais: Controles avançados de funções e suporte a SCIM para ambientes empresariais.

Instalação

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

Pré-requisitos

Etapas

  1. Clone o repositório:

    git clone https://github.com/delano/postman-api-server.git
cd postman-api-server

  2. Instale as dependências:

    pnpm install

  3. Compile o servidor:

    pnpm run build

  4. Execute em modo de desenvolvimento com recompilação automática:

    pnpm run watch

Uso

Configurando chaves de API

  1. Gere sua chave de API

  2. Configure a chave de API

    • Adicione a chave ao seu ambiente como POSTMAN_API_KEY
    • Para Claude Desktop ou Cline, inclua-a no arquivo de configuração (veja os exemplos de configuração abaixo)
    • Nunca envie chaves de API para o controle de versão

  3. Verifique o acesso

    • A chave de API fornece acesso a todos os recursos do Postman para os quais você tem permissões
    • 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.

claude-desktop-settings

Exemplo de configuração

{
  "mcpServers": {
    "postman": {
      "command": "node",
      "args": [
        "/path/to/postman-api-server/build/index.js"
      ],
      "env": {
        "POSTMAN_API_KEY": "CHANGEME"
      }
    }
  }
}

Usando o Cline

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

cline-settings

Exemplo de configuração

O mesmo que o 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, servidores mock, monitores e muito mais. Além disso, o guia oferece pré-requisitos e instruções de início rápido para facilitar interações perfeitas 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 de API para uma visão geral da estrutura da documentação e das estratégias de implementação.

Convertendo 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 múltiplas 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:

  1. Operações complexas
  • Gerenciamento de múltiplas coleções
  • Coordenação de ambientes
  • Geração de relatórios abrangentes
  1. Automação orientada por IA
  • Fluxos de trabalho de testes automatizados
  • Manutenção de documentação de API
  • Gerenciamento de ambientes
  1. Operações sensíveis a erros
  • Testes críticos de API
  • Implantações em produção
  • Verificação de conformidade

Fornece menos valor para:

  1. Operações simples
  • Execuções básicas de coleções
  • Chamadas únicas de API
  • Verificações rápidas de ambiente
  1. Uso direto de CLI
  • Operações conduzidas por desenvolvedores
  • Testes locais
  • Iterações rápidas

Desenvolvimento

Instale as dependências:

pnpm install

Compile o servidor:

pnpm run build

Para desenvolvimento com recompilação automática:

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:

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 a POSTMAN_API_KEY antes de conectar. Navegue até "Tools" para começar.

Outros servidores MCP

Licença

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