Meilisearch

• Lihat pengaturan koneksi saat ini
• Beralih antarinstans Meilisearch secara dinamis
• Perbarui kunci API kapan saja

• Buat indeks baru dengan kunci utama khusus
• Tampilkan semua indeks beserta statistiknya
• Hapus indeks dan datanya
• Dapatkan metrik indeks secara terperinci

• Tambahkan atau perbarui dokumen
• Ambil dokumen dengan paginasi
• Impor data secara massal

• Cari dengan filter, pengurutan, dan faset
• Pencarian multi-indeks
• Pencarian semantik dengan vektor
• Pencarian hibrida (kata kunci + semantik)

• Konfigurasikan aturan pemeringkatan
• Siapkan faset dan pemfilteran
• Kelola atribut yang dapat dicari
• Sesuaikan toleransi kesalahan ketik

• Buat dan kelola kunci API
• Tetapkan izin terperinci
• Pantau penggunaan kunci

⚠️ Catatan: Anda dapat menambahkan dan memperbarui host serta kunci API langsung melalui chat demi kemudahan, tetapi pendekatan ini terutama dirancang untuk kebutuhan pengembangan (seperti menghubungkan beberapa instans kapan saja). Pendekatan ini tidak mengikuti praktik keamanan MCP terbaik dan tidak boleh digunakan di lingkungan produksi tanpa perlindungan yang memadai.

• Pemeriksaan kesehatan
• Statistik sistem
• Pemantauan tugas
• Informasi versi

Alat yang Tersedia

Pengelolaan Koneksi

• get-connection-settings: Lihat URL koneksi Meilisearch saat ini dan status kunci API
• update-connection-settings: Perbarui URL dan/atau kunci API untuk terhubung ke instans lain

Pengelolaan Indeks

• create-index: Buat indeks baru dengan kunci utama opsional
• list-indexes: Tampilkan semua indeks yang tersedia
• delete-index: Hapus indeks yang ada beserta semua dokumennya
• get-index-metrics: Dapatkan metrik terperinci untuk indeks tertentu

Operasi Dokumen

• get-documents: Ambil dokumen dari indeks dengan paginasi
• add-documents: Tambahkan atau perbarui dokumen dalam indeks

Pencarian

• search: Pencarian fleksibel di satu atau beberapa indeks dengan opsi pemfilteran dan pengurutan

Pengelolaan Pengaturan

• get-settings: Lihat pengaturan indeks saat ini
• update-settings: Perbarui pengaturan indeks (pemeringkatan, faset, dll.)

Pengelolaan Kunci API

• get-keys: Tampilkan semua kunci API
• create-key: Buat kunci API baru dengan izin tertentu
• delete-key: Hapus kunci API yang ada

Pengelolaan Tugas

• get-task: Dapatkan informasi tentang tugas tertentu
• get-tasks: Tampilkan tugas dengan filter opsional
• cancel-tasks: Batalkan tugas yang tertunda atau masuk antrean

Pemantauan Sistem

• health-check: Pemeriksaan kesehatan dasar
• get-health-status: Status kesehatan menyeluruh
• get-version: Dapatkan informasi versi Meilisearch
• get-stats: Dapatkan statistik basis data
• get-system-info: Dapatkan informasi tingkat sistem

Penyiapan Pengembangan

Prasyarat

1. Jalankan server Meilisearch:

   # 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. Pasang alat pengembangan:

   # 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
   

Menjalankan Pengujian

Proyek ini menyertakan pengujian integrasi menyeluruh untuk memverifikasi fungsionalitas alat MCP:

# 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/

Penting: Pengujian memerlukan instans Meilisearch yang berjalan di http://localhost:7700.

Kualitas Kode

# 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/

Panduan Kontribusi

1. Fork dan klon repositori
2. Siapkan lingkungan pengembangan dengan mengikuti bagian Penyiapan Pengembangan di atas
3. Buat branch fitur dari main
4. Tulis pengujian terlebih dahulu jika menambahkan fungsionalitas baru (Pengembangan Berbasis Pengujian)
5. Jalankan pengujian secara lokal untuk memastikan semuanya lulus sebelum melakukan commit
6. Format kode dengan Black dan pastikan kualitas kode
7. Commit perubahan dengan pesan commit yang deskriptif
8. Push ke fork Anda dan buat pull request

Alur Kerja Pengembangan

# 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

Panduan Pengujian

• Semua fitur baru harus menyertakan pengujian
• Pengujian harus lulus sebelum PR diajukan
• Gunakan nama pengujian yang deskriptif dan pernyataan yang jelas
• Uji kasus berhasil maupun gagal
• Pastikan Meilisearch berjalan sebelum menjalankan pengujian

Proses Rilis

Proyek ini menggunakan pembuatan versi dan publikasi otomatis ke PyPI. Proses rilis dirancang agar sederhana dan otomatis.

Cara Kerja Rilis

1. Publikasi Otomatis: Saat nomor versi di pyproject.toml berubah pada branch main, GitHub Action akan otomatis:

   • Membangun paket Python
   • Mempublikasikannya ke PyPI menggunakan trusted publishing
   • Membuat rilis baru di GitHub

2. Deteksi Versi: Alur kerja membandingkan versi saat ini di pyproject.toml dengan commit sebelumnya untuk mendeteksi perubahan

3. Publikasi PyPI: Menggunakan aksi publikasi resmi PyPA dengan trusted publishing (tanpa perlu kunci API manual)

Membuat Rilis Baru

Untuk membuat rilis baru, ikuti langkah-langkah berikut:

1. Tentukan Nomor Versi

Ikuti Pembuatan Versi Semantik (MAJOR.MINOR.PATCH):

• PATCH (misalnya, 0.4.0 → 0.4.1): Perbaikan bug, pembaruan dokumentasi, penyempurnaan kecil
• MINOR (misalnya, 0.4.0 → 0.5.0): Fitur baru, alat MCP baru, peningkatan signifikan
• MAJOR (misalnya, 0.5.0 → 1.0.0): Perubahan yang tidak kompatibel, perubahan API besar

2. Perbarui Versi dan Buat PR

# 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. Gabungkan ke Main

Setelah PR disetujui dan digabungkan ke main, GitHub Action akan otomatis:

1. Deteksi perubahan versi
2. Bangun paket
3. Publikasikan ke PyPI di https://pypi.org/p/meilisearch-mcp
4. Sediakan versi baru melalui pip install meilisearch-mcp

4. Verifikasi Rilis

Setelah penggabungan, verifikasi rilis:

# 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

File Alur Kerja Rilis

Rilis otomatis ditangani oleh .github/workflows/publish.yml, yang:

• Dipicu oleh push ke cabang main
• Memeriksa apakah versi pyproject.toml berubah
• Menggunakan Python 3.10 dan alat build resmi
• Mempublikasikan menggunakan trusted publishing (tidak memerlukan kunci API)
• Menyediakan output terperinci untuk debugging

Pemecahan Masalah Rilis

Rilis tidak terpicu: Periksa apakah versi di pyproject.toml benar-benar berubah di antara commit

Build gagal: Periksa log GitHub Actions untuk mengetahui kesalahan build paket Python

Publikasi PyPI gagal: Verifikasi nama paket dan pastikan trusted publishing dikonfigurasi dengan benar

Konflik versi: Pastikan nomor versi baru belum pernah digunakan di PyPI

Versi Pengembangan vs Produksi

• Pengembangan: Instal dari sumber menggunakan pip install -e .
• Produksi: Instal dari PyPI menggunakan pip install meilisearch-mcp
• Versi tertentu: Instal menggunakan pip install meilisearch-mcp==0.5.0