Postman MCP Server

Sürüm: v0.2.0

Postman API'sine erişim sağlayan bir MCP sunucusu. İşlevsellik resmi OpenAPI belirtimi temel alınarak oluşturulmuştur. Daha fazla bilgi için Postman API belgelerine bakın.

Bu proje Anthropic tarafından yapılan Model Context Protocol (MCP) girişiminin bir parçasıdır. Daha fazla bilgi için MCP GitHub deposunu ve Anthropic blog'undaki duyuruyu ziyaret edin.

Kurulum talimatlarına atla

[!WARNING] Bu proje şu anda etkin geliştirme aşamasındadır. Lütfen dikkatli kullanınız ve değişikliklere hazırlıklı olunuz.

[!NOTE] Yapay Zeka tarafından üretilen kod. Cline v2.2.2 ile Claude 3.5 Sonnet (2024-10-22) kullanılmıştır. Komut dosyaları ve bu kodun nasıl oluşturulduğu hakkında ayrıntılar için docs/README.md dosyasına bakınız.

---

• Genel Bakış
• Özellikler
  • Koleksiyonlar
  • Ortamlar
  • API'ler
  • Kimlik Doğrulama & Yetkilendirme
  • Ek Özellikler
• Kurulum
  • Ön Koşullar
  • Adımlar
• Kullanım
  • API Anahtarlarını Ayarlama
  • Claude Desktop Kullanma
  • Cline Kullanma
  • Zed Kullanma
• Belgeler
  • Proje Genel Bakışı
• Gerekçe
• Geliştirme
• Hata Ayıklama
• Diğer MCP Sunucuları
• Lisans

Genel Bakış

Postman MCP Server, Postman API'si ile entegre olan ve Postman koleksiyonları, ortamları ve API'lerinin kapsamlı yönetimini sağlayan TypeScript tabanlı bir MCP sunucusudur.

Özellikler

Koleksiyonlar

• CRUD İşlemleri: Postman koleksiyonlarını oluşturun, alın, güncelleyin ve silin.
• Klasör Yönetimi: İstekleri koleksiyonlar içindeki klasörlerde düzenleyin.
• İstek Yönetimi: Koleksiyonlar içinde istekleri ekleyin, güncelleyin ve silin.
• Yanıt Yönetimi: İsteklerle ilişkili yanıtları yönetin.
• Sürüm Kontrolü: Koleksiyonlar için dallandırma, birleştirme ve değişiklikleri çekme işlemleri yapın.
• Açıklamalar: Koleksiyonlarda açıklamalar ekleyin ve yönetin.

Ortamlar

• Ortamları Yönetin: Farklı kurulumlar için ortamlar oluşturun ve alın.
• CRUD İşlemleri: Ortamları oluşturma, güncelleme ve silme konusunda tam destek.

API'ler

• API Yönetimi: API'leri oluşturun, alın, güncelleyin ve silin.
• Şema Desteği: Çok dosya desteğiyle API şemalarını yönetin.
• Etiketleme: API'ler için etiketler ekleyin ve yönetin.
• Açıklamalar: API'lerde açıklamalar ekleyin ve yönetin.

Kimlik Doğrulama & Yetkilendirme

• API Anahtarı Kimlik Doğrulaması: API anahtarlarını kullanarak güvenli erişim sağlayın.
• Rol Tabanlı Erişim Kontrolü: Çalışma alanı ve koleksiyon düzeylerinde izinleri yönetin.
• Çalışma Alanı İzinleri: Çalışma alanlarına özgü izinleri tanımlayın.

Ek Özellikler

• Özel API Ağı: Özel bir API ağı içindeki öğeleri ve klasörleri yönetin.
• Webhooks: Özel yükler ile koleksiyonları tetiklemek için webhook'lar oluşturun.
• Kurumsal Özellikler: Kurumsal ortamlar için gelişmiş rol kontrolleri ve SCIM desteği.

Kurulum

Smithery Aracılığıyla Kurulum

Postman MCP Server'ı Claude Desktop'a Smithery aracılığıyla otomatik olarak yüklemek için:

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

Ön Koşullar

• Node.js yüklü olmalıdır.

Adımlar

1. Depoyu klonlayın:

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

2. Bağımlılıkları yükleyin:

   pnpm install
   

3. Sunucuyu derleyin:

   pnpm run build
   

4. Geliştirme modunda otomatik yeniden derleme ile çalıştırın:

   pnpm run watch
   

Kullanım

API Anahtarlarını Ayarlama

1. API Anahtarınızı Oluşturun

   • Postman Hesap Ayarları sayfasını ziyaret edin
   • "Generate API Key" düğmesini tıklayın
   • Anahtarı güvenli bir şekilde saklayın - bir daha gösterilmeyecektir

2. API Anahtarını Yapılandırın

   • Anahtarı ortamınıza POSTMAN_API_KEY olarak ekleyin
   • Claude Desktop veya Cline için, yapılandırma dosyanıza ekleyin (aşağıdaki yapılandırma örneklerine bakınız)
   • API anahtarlarını hiçbir zaman sürüm kontrolüne kaydetmeyin

3. Erişimi Doğrulayın

   • API anahtarı, izniniz olan tüm Postman kaynaklarına erişim sağlar
   • Basit bir sorgu çalıştırarak erişimi test edin (örneğin, çalışma alanlarını listele)

[!NOTE] Postman API koleksiyonunu doğrudan kullanıyorsanız, API anahtarınızı postman-api-key koleksiyon değişkeni olarak saklayın.

Claude Desktop Kullanma

Claude Desktop ile kullanmak için sunucu yapılandırmasını ekleyin:

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

[!IMPORTANT] Bu sağlayıcıyı güncellerseniz, Claude input şemasından API değişikliklerini almak için yeniden başlatılmalıdır (yani MCP sunucusunun ToolDefinition öğeleri değiştiğinde). Bunun nedeni, Claude'un başlangıçta araç tanımlarını önbelleğe almasıdır.

Örnek yapılandırma

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

Cline Kullanma

Yukarıdaki aynı örnek yapılandırmayı kullanarak, sunucu yapılandırmasını Cline MCP Sunucuları yapılandırmanıza ekleyin:

Örnek yapılandırma

Yukarıdaki Claude ile aynı.

Zed Kullanma

Bunu çalışır hale getirmeye çalışıyorum. Zed belgelerinden anlaşıldığına göre bir eklenti olması gerekiyor (ayrıca bu issue #21455).

---

Belgeler

Resmi Postman API belgelerine Postman Public Workspace bölümünde ulaşabilirsiniz.

Proje Genel Bakışı

Postman API Referansları & Özetleri

Bu proje, OpenAPI belirtimini TypeScript koduna dönüştürmek için Claude modelini ve Cline uzantısını kullanır, MCP sunucusu içinde tür güvenliğini ve entegrasyonu artırır.

Bu GitHub projesi, Postman platformunu programlı şekilde kullanma konusunda ayrıntılı rehberlik sağlayan API Referansları belgelerine sahiptir. Hem yerel geliştirme için Collection SDK'sini hem de bulut platformu entegrasyonu için Postman API'sini kapsar. Temel konular kimlik doğrulama mekanizmaları, hız sınırları ve çalışma alanları, koleksiyonlar, ortamlar, mock sunucuları, monitörler ve daha fazlasını kapsayan tüm API endpoint'lerinin ayrıntılı belgeleri içerir. Ayrıca rehber, sorunsuz API etkileşimlerini kolaylaştırmak için ön koşullar ve hızlı başlangıç talimatları sunmaktadır.

docs/api/summaries dizini Postman API'nin kapsamlı Markdown özetlerini içerir. Bu belgeler API endpoint'lerini, istek/yanıt formatlarını ve MCP sunucusunun işlevselliğini doğrulamak ve sağlamak için gerekli olan uygulama ayrıntılarını ana hatlarıyla sunmaktadır. Belge yapısı ve uygulama stratejilerine genel bir bakış için API Özetleri README dosyasına bakınız.

OpenAPI Spec'i TypeScript Koduna Claude ile Dönüştürme

MCP Sunucusunu Oluşturma

MCP sunucu handler'larını uygulamaya ilişkin ayrıntılı belirtimler için Handlers Belgelerine bakınız. Bu, URI formatlarını, prompt gereksinimlerini ve kaynak yönetimi kalıplarını içerir. Bu rehber, Postman API işlevselliklerini MCP sunucusu içinde entegre etme ve geliştirme üzerinde çalışan geliştiriciler için çok önemlidir.

---

Gerekçe

Postman araçları için MCP sarıcısı, yapı ve güvenliğin çok önemli olduğu karmaşık, çok aşamalı işlemler için bir AI etkileşim katmanı olarak mantıklıdır. Ancak, doğrudan CLI veya API kullanımının yeterli olduğu basit işlemler için aşırı mühendislik yapılmış olabilir. MCP sarıcısı en çok şu durumlarda değer sağlar:

1. Karmaşık İşlemler

• Birden fazla koleksiyonu yönetme
• Ortamları koordine etme
• Kapsamlı raporlar oluşturma

2. Yapay Zeka Tarafından Yönetilen Otomasyon

• Otomatik test iş akışları
• API belgeleri bakımı
• Ortam yönetimi

3. Hataya Duyarlı İşlemler

• Kritik API testi
• Üretim dağıtımları
• Uyumluluk kontrolü

Aşağıdaki durumlarda daha az değer sağlar:

1. Basit İşlemler

• Temel koleksiyon çalıştırmaları
• Tekil API çağrıları
• Hızlı ortam kontrolleri

2. Doğrudan CLI Kullanımı

• Geliştirici tarafından yönetilen işlemler
• Yerel test
• Hızlı yinelemeler

Geliştirme

Bağımlılıkları yükleyin:

pnpm install

Sunucuyu derleyin:

pnpm run build

Otomatik yeniden derleme ile geliştirme için:

pnpm run watch

Hata Ayıklama

MCP sunucuları stdio üzerinden iletişim kurduğundan hata ayıklama zor olabilir. MCP Inspector kullanmanızı öneriyoruz, paket script'i olarak mevcuttur:

pnpm run inspector

Belgeler

Inspector, tarayıcınızda hata ayıklama araçlarına erişmek için bir URL sağlayacaktır: http://localhost:5173. Bağlanmadan önce POSTMAN_API_KEY'i eklemeniz gerekir. Başlamak için "Tools" sayfasına gidin.

Diğer MCP Sunucuları

• AppCypher tarafından Awesome MCP Servers
• PunkPeye tarafından Awesome MCP Servers

Lisans

Bu proje MIT Lisansı altında lisanslanmıştır. Ayrıntılar için LICENSE dosyasına bakınız.