ikas api docs mcp

🇹🇷 Türkçe | 🇬🇧 English

ikas.dev dokümantasyonunu LLM'lere sunan MCP sunucusu. Model Context Protocol aracılığıyla ikas API dokümantasyonuna, GraphQL şemalarına ve kod örneklerine anında erişim sağlar.

⚠️ Önemli Uyarı

Bu, bağımsız olarak geliştirilmiş bir MCP sunucusudur ve bireysel bir geliştirici tarafından oluşturulmuştur. ikas ile herhangi bir bağlantım yoktur ve ikas'ta çalışmıyorum. Bu araç, geliştirici topluluğu için olduğu gibi sunulmaktadır. Bu MCP sunucusuyla ilgili teknik sorunlar için lütfen bu repository'de issue açın - ikas destek ekibiyle iletişime geçmeyin çünkü bu araçtan sorumlu değiller.

Yıldız Geçmişi

Kurulum

# Repository'yi klonlayın
git clone https://github.com/atapinar/ikas-api-docs-mcp.git
cd ikas-api-docs-mcp

# Bağımlılıkları yükleyin
npm install

# Projeyi derleyin
npm run build

# İlk taramayı yapın (opsiyonel ama tavsiye edilir)
node build/demo-workflow.js

Faz 1 Tamamlandı ✓

Başarıyla tamamlanan özellikler:

• ✓ TypeScript ve tüm bağımlılıklarla proje kurulumu
• ✓ Hem statik hem de JS-render edilmiş sayfaları destekleyen temel scraper
• ✓ Tam CRUD işlemli dosya tabanlı önbellek sistemi
• ✓ Temel araçlarla minimal MCP sunucusu

Faz 2 Tamamlandı ✓

Gelişmiş içerik çıkarma ve MCP araçları:

• ✓ Yapılandırılmış veriyle akıllı içerik çıkarma
• ✓ GraphQL şema ayrıştırma ve analizi
• ✓ Kod örneği çıkarma
• ✓ API endpoint keşfi
• ✓ 11 özelleştirilmiş MCP aracı

Faz 3 Tamamlandı ✓

Arama ve Keşif:

• ✓ Dokümantasyon sayfalarını otomatik keşfeden akıllı tarayıcı
• ✓ Anahtar kelime çıkarmalı tam metin arama indeksi
• ✓ Hızlı aramalar için GraphQL tip indeksleme
• ✓ Kategori ve tip filtrelemeli gelişmiş arama
• ✓ Taramalardan sonra otomatik indeks yenileme
• ✓ Toplam 14 MCP aracı:
  • crawl_site: Dokümantasyon sayfalarını keşfet ve önbelleğe al
  • rebuild_index: Arama indeksini yeniden oluştur
  • search_advanced: Filtreli gelişmiş arama

Hızlı Başlangıç

Claude Desktop ile

1. Claude Desktop config dosyanıza ekleyin (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "ikas-docs-scraper": {
      "command": "node",
      "args": ["/path/to/ikas-docs-scraper-mcp/build/index.js"],
      "env": {
        "NODE_ENV": "production"
      }
    }
  }
}

2. Claude Desktop'ı yeniden başlatın

3. Sohbetlerinizde araçları kullanın!

MCP Inspector ile

# Yerel test
npm run mcp:test

# Veya özel portlarla
npm run mcp:test:alt

MCP Sunucusunu Test Edin

1. MCP Inspector kullanarak:

npx @modelcontextprotocol/inspector node build/index.js

2. Claude Desktop'ı yapılandırın: claude_desktop_config.json içeriğini Claude Desktop yapılandırmanıza kopyalayın.

Mevcut Araçlar

Temel Araçlar

• get_page: Herhangi bir ikas dokümantasyon sayfasını veya playground'u gelişmiş çıkarmayla getirir
• search_docs: Tüm önbelleğe alınmış sayfalarda hızlı indeksli arama
• search_advanced: Kategori/tip filtreleriyle arama
• cache_stats: Önbellek istatistiklerini ve URL'lerini gösterir

GraphQL Araçları

• find_graphql_type: Tip tanımlarını bulur (Product, Order, vb.)
• find_mutation: Mutation'ları bulur (ürün oluştur, sipariş güncelle, vb.)
• find_query: Veri çekme için query'leri bulur
• find_code_example: Konuya ve dile göre kod örnekleri bulur

Keşif Araçları

• crawl_site: Dokümantasyon sayfalarını otomatik keşfet ve önbelleğe al
• rebuild_index: Arama indeksini yeniden oluştur
• list_categories: Tüm dokümantasyon kategorilerini listeler

Yakında

• get_field_info: Detaylı alan bilgisi al
• get_api_endpoint: API endpoint bilgisi al
• explain_error: Hataları çözümleriyle açıkla

Kullanım Örnekleri

İlk Kurulum

1. Dokümantasyonu tarayın (yerel önbelleğinizi oluşturur):

crawl_site { "maxPages": 50 }

2. Belirli konuları arayın:

search_docs { "query": "ürün varyantları" }

3. GraphQL tiplerini bulun:

find_graphql_type { "typeName": "Product" }

4. Mutation'ları bulun:

find_mutation { "action": "create", "entity": "product" }

5. Belirli dokümantasyonu alın:

get_page { "url": "https://ikas.dev/docs/api/admin-api/products" }

Geliştirme

# Geliştirme modunda çalıştır
npm run dev

# Testleri çalıştır
npm test

# Tip kontrolü
npm run typecheck

# Lint
npm run lint

Katkıda Bulunma

Katkılarınızı bekliyoruz! Lütfen Pull Request göndermekten çekinmeyin.

Lisans

MIT

Teşekkürler

• Model Context Protocol ile geliştirildi
• Puppeteer ve Cheerio tarafından destekleniyor
• ikas geliştirici topluluğu için oluşturuldu