Meilisearch

resmi

Meilisearch ile etkileşim kurun ve sorgulama yapın (Tam metin ve anlamsal arama API'si)

GitHub
198

Meilisearch MCP ile neler yapabilirsiniz?

  • Dizin yönetimi — Arama dizinleri oluşturun, listeleyin ve silin; oluştururken özel bir birincil anahtar da belirleyin.
  • Belge yönetimi — Bir dizindeki belgeleri ekleyin veya güncelleyin ve sayfalama kullanarak alın.
  • Arama — Filtreler, sıralama ve fasetlerle bir veya birden fazla dizinde arama yapın.
  • Ayar denetimi — Sıralama kuralları, fasetleme ve aranabilir öznitelikler gibi dizin ayarlarını görüntüleyin ve güncelleyin.
  • Görev ve sistem durumu izleme — Örnek sistem durumunu, sürümünü ve istatistiklerini kontrol edin; dizin oluşturma görevlerini izleyin veya iptal edin.
  • API anahtarı yönetimi — Belirli izinlere sahip API anahtarlarını listeleyin, oluşturun ve silin.

Dokümantasyon

Meilisearch

Meilisearch MCP Sunucusu

Meilisearch | Meilisearch Cloud | Belgeler | Discord

PyPI version Python Versions Tests License Downloads

[!WARNING] Bu paket kullanımdan kaldırılmıştır. Bunun yerine yerel Meilisearch MCP sunucusunu kullanın.

Meilisearch artık yerleşik bir MCP sunucusu sunuyor (Meilisearch v1.54 ve sonrası). Sunucu, HTTP üzerinden örneğinizin /mcp rotasında kullanıma sunulur; bu nedenle artık bu Python paketini yüklemeniz veya çalıştırmanız gerekmez.

👉 Kurulum için Meilisearch MCP kılavuzunu izleyin.

Bu depo, yerel destek sunulmadan önce oluşturulmuş bir stdio sarmalayıcısıdır. Artık etkin olarak bakımı yapılmamaktadır ve yalnızca mevcut kullanıcılar için tutulmaktadır.

⚡ Herhangi bir LLM'yi Meilisearch'e bağlayın ve ışık hızında arama özellikleriyle yapay zekânızı güçlendirin! 🔍

🤔 Bu nedir?

Meilisearch MCP Sunucusu, Claude, OpenAI ajanları ve diğer LLM'ler dâhil olmak üzere MCP uyumlu tüm istemcilerin Meilisearch ile etkileşim kurmasını sağlayan bir Model Context Protocol sunucusudur. stdio tabanlı bu sunucu, yapay zekâ asistanlarının arama indekslerini yönetmesine, arama yapmasına ve doğal konuşmalar aracılığıyla verilerinizi işlemesine olanak tanır.

Neden kullanmalısınız?

  • 🤖 Evrensel Uyumluluk - Yalnızca Claude ile değil, tüm MCP istemcileriyle çalışır
  • 🗣️ Doğal Dille Kontrol - Herhangi bir LLM ile konuşarak Meilisearch'i yönetin
  • 🚀 Öğrenme Gerektirmez - Meilisearch API'sini öğrenmenize gerek yok
  • 🔧 Tüm Özelliklere Erişim - Meilisearch'in tüm özellikleri parmaklarınızın ucunda
  • 🔄 Dinamik Bağlantılar - Meilisearch örnekleri arasında anında geçiş yapın
  • 📡 stdio Aktarımı - Yalnızca stdio kullanır; HTTP için yerel Meilisearch MCP sunucusunu kullanın

✨ Öne Çıkan Özellikler

  • 📊 İndeks ve Belge Yönetimi - Arama indeksleri oluşturun, güncelleyin ve yönetin
  • 🔍 Akıllı Arama - Gelişmiş filtreleme ile tek veya birden fazla indekste arama yapın
  • ⚙️ Ayarları Yapılandırma - Arama alaka düzeyini ve performansını ince ayarlayın
  • 📈 Görev İzleme - İndeksleme ilerlemesini ve sistem işlemlerini takip edin
  • 🔐 API Anahtarı Yönetimi - Güvenli erişim denetimi
  • 🏥 Sağlık İzleme - Meilisearch örneğinizin durumunu takip edin
  • 🧱 Yapılandırılmış Araç Çıktısı - Veri döndüren her araç, en güncel MCP belirtimine uygun olarak metnin yanı sıra structuredContent sağlar
  • 🔀 Modern MCP Yığını - Resmî MCP Python SDK v2 (spec 2026-07-28) üzerine kuruludur ve eski MCP istemcileriyle geriye dönük uyumludur
  • 🐍 Python Uygulaması - TypeScript sürümü de mevcuttur

🚀 Hızlı Başlangıç

Yalnızca 3 adımda kullanmaya başlayın!

1️⃣ Paketi yükleyin

# Using pip
pip install meilisearch-mcp

# Or using uvx (recommended)
uvx -n meilisearch-mcp

2️⃣ Claude Desktop'ı yapılandırın

Bunu claude_desktop_config.json dosyanıza ekleyin:

{
  "mcpServers": {
    "meilisearch": {
      "command": "uvx",
      "args": ["-n", "meilisearch-mcp"]
    }
  }
}

3️⃣ Meilisearch'i başlatın

# Using Docker (recommended)
docker run -d -p 7700:7700 getmeili/meilisearch:v1.28

# Or using Homebrew
brew install meilisearch
meilisearch

Hepsi bu kadar! Artık yapay zekâ asistanınızdan Meilisearch verilerinizi aramasını ve yönetmesini isteyebilirsiniz! 🎉

📚 Örnekler

💬 Yapay zekâ asistanınızla doğal bir şekilde konuşun:

You: "Create a new index called 'products' with 'id' as the primary key"
AI: I'll create that index for you... ✓ Index 'products' created successfully!

You: "Add some products to the index"
AI: I'll add those products... ✓ Added 5 documents to 'products' index

You: "Search for products under $50 with 'electronics' in the category"
AI: I'll search for those products... Found 12 matching products!

🔍 Gelişmiş Arama Örneği:

You: "Search across all my indices for 'machine learning' and sort by date"
AI: Searching across all indices... Found 47 results from 3 indices:
- 'blog_posts': 23 articles about ML
- 'documentation': 15 technical guides
- 'tutorials': 9 hands-on tutorials

🔧 Kurulum

Ön Koşullar

  • Python ≥ 3.10
  • Çalışan bir Meilisearch örneği
  • MCP uyumlu istemci (Claude Desktop, OpenAI ajanları vb.)

PyPI'dan

pip install meilisearch-mcp

Kaynak Koddan (geliştirme için)

# Clone repository
git clone https://github.com/meilisearch/meilisearch-mcp.git
cd meilisearch-mcp

# Create virtual environment and install
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -e .

Docker Kullanarak

n8n iş akışları gibi kapsayıcılı ortamlar için idealdir!

Docker Hub'dan

# Pull the latest image
docker pull getmeili/meilisearch-mcp:latest

# Or a specific version
docker pull getmeili/meilisearch-mcp:0.5.0

# Run the container
docker run -it \
  -e MEILI_HTTP_ADDR=http://your-meilisearch:7700 \
  -e MEILI_MASTER_KEY=your-master-key \
  getmeili/meilisearch-mcp:latest

Kaynak Koddan Derleme

# Build your own image
docker build -t meilisearch-mcp .
docker run -it \
  -e MEILI_HTTP_ADDR=http://your-meilisearch:7700 \
  -e MEILI_MASTER_KEY=your-master-key \
  meilisearch-mcp

n8n ile Entegrasyon

n8n iş akışlarında Docker imajını doğrudan kurulumunuzda kullanabilirsiniz:

meilisearch-mcp:
  image: getmeili/meilisearch-mcp:latest
  environment:
    - MEILI_HTTP_ADDR=http://meilisearch:7700
    - MEILI_MASTER_KEY=masterKey

🛠️ Neler Yapabilirsiniz?

🔗 Bağlantı Yönetimi
  • Geçerli bağlantı ayarlarını görüntüleyin
  • Meilisearch örnekleri arasında dinamik olarak geçiş yapın
  • API anahtarlarını anında güncelleyin
📁 İndeks İşlemleri
  • Özel birincil anahtarlarla yeni indeksler oluşturun
  • Tüm indeksleri istatistikleriyle birlikte listeleyin
  • İndeksleri ve verilerini silin
  • Ayrıntılı indeks ölçümlerini alın
📄 Belge Yönetimi
  • Belge ekleyin veya güncelleyin
  • Sayfalama kullanarak belgeleri alın
  • Verileri toplu olarak içe aktarın
🔍 Arama Özellikleri
  • Filtreler, sıralama ve fasetlerle arama yapın
  • Birden fazla indekste arama yapın
  • Vektörlerle anlamsal arama yapın
  • Hibrit arama (anahtar kelime + anlamsal)
⚙️ Ayarlar ve Yapılandırma
  • Sıralama kurallarını yapılandırın
  • Fasetleme ve filtrelemeyi ayarlayın
  • Aranabilir öznitelikleri yönetin
  • Yazım hatası toleransını özelleştirin
🔐 Güvenlik
  • API anahtarları oluşturun ve yönetin
  • Ayrıntılı izinler belirleyin
  • Anahtar kullanımını izleyin

⚠️ Not: Kolaylık sağlamak için sohbet üzerinden doğrudan ana makine ve API anahtarı ekleyip güncelleyebilirsiniz; ancak bu yaklaşım öncelikle geliştirme senaryoları (örneğin, anında birden fazla örneğe bağlanma) için tasarlanmıştır. En iyi MCP güvenlik uygulamalarına uymaz ve uygun korumalar olmadan üretim ortamlarında kullanılmamalıdır.

📊 İzleme ve Sağlık
  • Sağlık kontrolleri
  • Sistem istatistikleri
  • Görev izleme
  • Sürüm bilgileri

🌍 Ortam Değişkenleri

Varsayılan bağlantı ayarlarını yapılandırın:

MEILI_HTTP_ADDR=http://localhost:7700  # Default Meilisearch URL
MEILI_MASTER_KEY=your_master_key       # Optional: Default API key

💻 Geliştirme

Geliştirme Ortamını Kurma

  1. Meilisearch'i başlatın:

    docker run -d -p 7700:7700 getmeili/meilisearch:v1.28

  2. Geliştirme Bağımlılıklarını Yükleyin:

    uv pip install -r requirements-dev.txt

  3. Testleri Çalıştırın:

    python -m pytest tests/ -v

  4. Kodu Biçimlendirin:

    black src/ tests/

MCP Inspector ile Test Etme

npx @modelcontextprotocol/inspector python -m src.meilisearch_mcp

🤝 Topluluk ve Destek

Sizden haber almak isteriz! Yardım almak ve iletişim kurmak için:

🤗 Katkıda Bulunma

Katkılarınızı bekliyoruz! Başlamak için:

  1. Depoyu çatallayın
  2. Özellik dalınızı oluşturun (git checkout -b feature/amazing-feature)
  3. Değişiklikleriniz için testler yazın
  4. Değişikliklerinizi yapın ve testleri çalıştırın
  5. Kodunuzu black ile biçimlendirin
  6. Değişikliklerinizi kaydedin (git commit -m 'Add amazing feature')
  7. Dalınıza gönderin (git push origin feature/amazing-feature)
  8. Pull Request açın

Daha fazla bilgi için Katkıda Bulunma Yönergelerimize bakın.

📦 Sürüm Süreci

Bu proje otomatik sürüm oluşturma ve yayımlama kullanır. main dalındaki pyproject.toml değiştiğinde paket otomatik olarak PyPI'a yayımlanır.

Ayrıntılı talimatlar için Sürüm Süreci bölümüne bakın.

📄 Lisans

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

Meilisearch, keyifli bir arama deneyimi sunan açık kaynaklı bir arama motorudur.
Meilisearch hakkında daha fazla bilgi için meilisearch.com adresini ziyaret edin.

📖 Belgelerin Tamamı

Kullanılabilir Araçlar

Bağlantı Yönetimi

  • get-connection-settings: Geçerli Meilisearch bağlantı URL'sini ve API anahtarı durumunu görüntüleyin
  • update-connection-settings: Farklı bir örneğe bağlanmak için URL'yi ve/veya API anahtarını güncelleyin

İndeks Yönetimi

  • create-index: İsteğe bağlı birincil anahtarla yeni bir indeks oluşturun
  • list-indexes: Kullanılabilir tüm indeksleri listeleyin
  • delete-index: Mevcut bir indeksi ve tüm belgelerini silin
  • get-index-metrics: Belirli bir indeks için ayrıntılı ölçümleri alın

Belge İşlemleri

  • get-documents: Sayfalama kullanarak bir indeksten belgeleri alın
  • add-documents: Bir indekse belge ekleyin veya güncelleyin

Arama

  • search: Filtreleme ve sıralama seçenekleriyle tek veya birden fazla indekste esnek arama yapın

Ayar Yönetimi

  • get-settings: Bir indeksin geçerli ayarlarını görüntüleyin
  • update-settings: İndeks ayarlarını güncelleyin (sıralama, fasetleme vb.)

API Anahtarı Yönetimi

  • get-keys: Tüm API anahtarlarını listeleyin
  • create-key: Belirli izinlerle yeni bir API anahtarı oluşturun
  • delete-key: Mevcut bir API anahtarını silin

Görev Yönetimi

  • get-task: Belirli bir görev hakkında bilgi alın
  • get-tasks: İsteğe bağlı filtrelerle görevleri listeleyin
  • cancel-tasks: Bekleyen veya kuyruğa alınmış görevleri iptal edin

Sistem İzleme

  • health-check: Temel sağlık kontrolü
  • get-health-status: Kapsamlı sağlık durumu
  • get-version: Meilisearch sürüm bilgilerini alın
  • get-stats: Veritabanı istatistiklerini alın
  • get-system-info: Sistem düzeyinde bilgileri alın

Geliştirme Kurulumu

Ön Koşullar

  1. Meilisearch sunucusunu başlatın:

    # Using Docker (recommended for development)
docker run -d -p 7700:7700 getmeili/meilisearch:v1.28

# Or using brew (macOS)
brew install meilisearch
meilisearch

# Or download from https://github.com/meilisearch/meilisearch/releases

  2. Geliştirme araçlarını yükleyin:

    # Install uv for Python package management
pip install uv

# Install Node.js for MCP Inspector testing
# Visit https://nodejs.org/ or use your package manager

Testleri Çalıştırma

Bu proje, MCP araçlarının işlevselliğini doğrulayan kapsamlı entegrasyon testleri içerir:

# Run all tests
python -m pytest tests/ -v

# Run specific test file
python -m pytest tests/test_mcp_client.py -v

# Run tests with coverage report
python -m pytest --cov=src tests/

# Run tests in watch mode (requires pytest-watch)
pytest-watch tests/

Önemli: Testler için http://localhost:7700 üzerinde çalışan bir Meilisearch örneği gerekir.

Kod Kalitesi

# Format code with Black
black src/ tests/

# Run type checking (if mypy is configured)
mypy src/

# Lint code (if flake8 is configured)
flake8 src/ tests/

Katkıda Bulunma Yönergeleri

  1. Depoyu çatallayın ve klonlayın
  2. Yukarıdaki Geliştirme Kurulumu bölümündeki adımları izleyerek geliştirme ortamını kurun
  3. main dalından bir özellik dalı oluşturun
  4. Yeni işlevler ekliyorsanız önce testleri yazın (Test Odaklı Geliştirme)
  5. Kaydetmeden önce tüm testlerin geçtiğinden emin olmak için testleri yerel olarak çalıştırın
  6. Black ile kodu biçimlendirin ve kod kalitesini sağlayın
  7. Açıklayıcı commit mesajlarıyla değişiklikleri kaydedin
  8. Fork'unuza gönderin ve bir pull request oluşturun

Geliştirme İş Akışı

# Create feature branch
git checkout -b feature/your-feature-name

# Make your changes, write tests first
# Edit files...

# Run tests to ensure everything works
python -m pytest tests/ -v

# Format code
black src/ tests/

# Commit and push
git add .
git commit -m "Add feature description"
git push origin feature/your-feature-name

Test Yönergeleri

  • Tüm yeni özellikler test içermelidir
  • PR göndermeden önce testler başarılı olmalıdır
  • Açıklayıcı test adları ve anlaşılır doğrulamalar kullanın
  • Hem başarılı hem de hatalı durumları test edin
  • Testleri çalıştırmadan önce Meilisearch'in çalıştığından emin olun

Sürüm Süreci

Bu proje, PyPI'a otomatik sürüm oluşturma ve yayımlama kullanır. Sürüm süreci basit ve otomatik olacak şekilde tasarlanmıştır.

Sürümler Nasıl Çalışır?

  1. Otomatik Yayımlama: main dalındaki pyproject.toml sürüm numarası değiştiğinde bir GitHub Action otomatik olarak:

    • Python paketini derler
    • Güvenilir yayımlama kullanarak PyPI'a yayımlar
    • GitHub'da yeni bir sürüm oluşturur

  2. Sürüm Algılama: İş akışı, değişiklikleri algılamak için pyproject.toml dosyasındaki geçerli sürümü önceki commit ile karşılaştırır

  3. PyPI Yayımlama: Güvenilir yayımlama kullanan PyPA'nın resmî yayımlama eylemini kullanır (manuel API anahtarları gerekmez)

Yeni Bir Sürüm Oluşturma

Yeni bir sürüm oluşturmak için şu adımları izleyin:

1. Sürüm Numarasını Belirleyin

Anlamsal Sürüm Oluşturma (MAJOR.MINOR.PATCH) kurallarını izleyin:

  • PATCH (ör. 0.4.0 → 0.4.1): Hata düzeltmeleri, belge güncellemeleri, küçük iyileştirmeler
  • MINOR (ör. 0.4.0 → 0.5.0): Yeni özellikler, yeni MCP araçları, önemli geliştirmeler
  • MAJOR (ör. 0.5.0 → 1.0.0): Geriye dönük uyumluluğu bozan değişiklikler, büyük API değişiklikleri
2. Sürümü Güncelleyin ve PR Oluşturun
# 1. Create a branch from latest main
git checkout main
git pull origin main
git checkout -b release/v0.5.0

# 2. Update version in pyproject.toml
# Edit the version = "0.4.0" line to your new version

# 3. Commit and push
git add pyproject.toml
git commit -m "Bump version to 0.5.0"
git push origin release/v0.5.0

# 4. Create PR and get it reviewed/merged
gh pr create --title "Release v0.5.0" --body "Bump version for release"
3. Main Dalına Birleştirin

PR onaylanıp main dalına birleştirildikten sonra GitHub Action otomatik olarak:

  1. Sürüm değişikliğini algılayın
  2. Paketi derleyin
  3. PyPI'da https://pypi.org/p/meilisearch-mcp adresinde yayımlayın
  4. Yeni sürümü pip install meilisearch-mcp aracılığıyla kullanıma sunun
4. Sürümü Doğrulayın

Birleştirme işleminden sonra sürümü doğrulayın:

# Check GitHub Action status
gh run list --workflow=publish.yml

# Verify on PyPI (may take a few minutes)
pip index versions meilisearch-mcp

# Test installation of new version
pip install --upgrade meilisearch-mcp

Sürüm İş Akışı Dosyası

Otomatik sürüm işlemi, aşağıdaki işlemleri yapan .github/workflows/publish.yml tarafından yürütülür:

  • main dalına yapılan gönderimlerde tetiklenir
  • pyproject.toml sürümünün değişip değişmediğini kontrol eder
  • Python 3.10 ve resmî derleme araçlarını kullanır
  • Güvenilir yayımlama yöntemini kullanarak yayımlar (API anahtarı gerekmez)
  • Hata ayıklama için ayrıntılı çıktı sağlar

Sürüm Sorunlarını Giderme

Sürüm işlemi tetiklenmedi: pyproject.toml içindeki sürümün commit'ler arasında gerçekten değiştiğini kontrol edin

Derleme başarısız oldu: Python paketi derleme hataları için GitHub Actions günlüklerini kontrol edin

PyPI yayımlama işlemi başarısız oldu: Paket adını ve güvenilir yayımlama yapılandırmasının doğru olduğunu doğrulayın

Sürüm çakışmaları: Yeni sürüm numarasının PyPI'da daha önce kullanılmadığından emin olun

Geliştirme ve Üretim Sürümleri

  • Geliştirme: pip install -e . kullanarak kaynaktan yükleyin
  • Üretim: pip install meilisearch-mcp kullanarak PyPI'dan yükleyin
  • Belirli bir sürüm: pip install meilisearch-mcp==0.5.0 kullanarak yükleyin