Postman MCP Server

Servidor MCP do Postman

Um servidor MCP (Model Context Protocol) que permite executar coleções do Postman usando Newman. Este servidor permite que LLMs executem testes de API e obtenham resultados detalhados por meio de uma interface padronizada.

Listagem de Agentes de IA

Recursos

• Executar coleções do Postman usando Newman
• Suporte para arquivos de ambiente
• Suporte para variáveis globais
• Resultados detalhados de testes, incluindo:
  • Status geral de sucesso/falha
  • Resumo dos testes (total, aprovados, reprovados)
  • Informações detalhadas de falhas
  • Tempos de execução

Instalação

Instalação via Smithery

Para instalar o Postman Runner para Claude Desktop automaticamente via Smithery:

npx -y @smithery/cli install mcp-postman --client claude

Instalação Manual

# Clone the repository
git clone <repository-url>
cd mcp-postman

# Install dependencies
pnpm install

# Build the project
pnpm build

Uso

Configuração

Adicione o servidor ao arquivo de configuração do Claude desktop em ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "postman-runner": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-postman/build/index.js"]
    }
  }
}

Ferramentas Disponíveis

run-collection

Executa uma coleção do Postman e retorna os resultados dos testes.

Parâmetros:

• collection (obrigatório): Caminho ou URL para a coleção do Postman
• environment (opcional): Caminho ou URL para o arquivo de ambiente
• globals (opcional): Caminho ou URL para o arquivo de globals
• iterationCount (opcional): Número de iterações a serem executadas

Exemplo de Resposta:

{
  "success": true,
  "summary": {
    "total": 5,
    "failed": 0,
    "passed": 5
  },
  "failures": [],
  "timings": {
    "started": "2024-03-14T10:00:00.000Z",
    "completed": "2024-03-14T10:00:01.000Z",
    "duration": 1000
  }
}

Exemplo de Uso no Claude

Você pode usar o servidor no Claude pedindo para ele executar uma coleção do Postman:

"Execute a coleção do Postman em /path/to/collection.json e me diga se todos os testes passaram"

O Claude irá:

1. Usar a ferramenta run-collection
2. Analisar os resultados dos testes
3. Fornecer um resumo amigável da execução

Desenvolvimento

Estrutura do Projeto

src/
  ├── index.ts           # Entry point
  ├── server/
  │   ├── server.ts     # MCP Server implementation
  │   └── types.ts      # Type definitions
  └── newman/
      └── runner.ts     # Newman runner implementation
test/
  ├── server.test.ts    # Server tests
  ├── newman-runner.test.ts  # Runner tests
  └── fixtures/         # Test fixtures
      └── sample-collection.json

Executando Testes

# Run tests
pnpm test

# Run tests with coverage
pnpm test:coverage

Compilação

# Build the project
pnpm build

# Clean build artifacts
pnpm clean

Contribuindo

1. Faça um fork do repositório
2. Crie sua branch de recurso (git checkout -b feature/amazing-feature)
3. Faça commit das suas alterações (git commit -m 'Add some amazing feature')
4. Envie para a branch (git push origin feature/amazing-feature)
5. Abra um Pull Request

Licença

ISC