Meilisearch MCP Server

🚀 Meilisearch MCP 服務器

Meilisearch MCP 服務器是一個強大的工具，它提供了豐富的搜索和索引管理功能，支持異步任務和日誌記錄等高級特性，能幫助開發者高效地構建搜索服務。

🚀 快速開始

在 package.json 中配置以下內容：

{
  "scripts": {
    "start": "mcp-server"
  }
}

然後運行：

npm run start

✨ 主要特性

• 搜索功能：支持基本搜索和高級搜索，滿足不同場景的搜索需求。
• 索引管理：可以方便地創建和刪除索引。
• 高級功能：具備異步任務和日誌記錄功能，提升系統的可維護性和性能。

📦 安裝指南

安裝步驟

1. 克隆倉庫

   git clone https://github.com/your-username/meilisearch-mcp-server.git
   cd meilisearch-mcp-server
   

2. 安裝依賴

   npm install
   

3. 啟動服務器

   npm start
   

💻 使用示例

基礎用法

const mcp = require('meilisearch-mcp-server');

async function main() {
  await mcp.createIndex('test_index');
  const result = await mcp.search('test_index', 'test_query');
  console.log(result);
}

main().catch(console.error);

高級用法

const mcp = require('meilisearch-mcp-server');

async function main() {
  // 創建索引
  await mcp.createIndex('complex_search');

  // 添加文檔
  const documents = [
    { id: 1, title: 'Introduction to Node.js', content: 'Learn Node.js basics.' },
    { id: 2, title: 'Advanced React Patterns', content: 'Master React techniques.' }
  ];
  await mcp.addDocuments('complex_search', documents);

  // 高級搜索
  const result = await mcp.advancedSearch('complex_search', {
    bool: {
      must: [
        { term: { field: 'status', value: 'active' } },
        { match_phrase: { field: 'content', value: 'Learn Node.js' } }
      ]
    }
  });

  console.log(result);
}

main().catch(console.error);

📚 詳細文檔

配置文件

創建或修改 config.json 文件：

{
  "host": "localhost",
  "port": 3000,
  "api_key": "your_api_key"
}

功能模塊

搜索功能

• 基本搜索

  const result = await mcp.search({
    index: 'your_index',
    query: 'search_term'
  });
  

- **高級搜索**
  ```javascript
  const result = await mcp.advancedSearch({
    index: 'your_index',
    query: {
      bool: {
        must: [
          { term: { field: 'status', value: 'active' } }
        ]
      }
    }
  });

索引管理

• 創建索引

  await mcp.createIndex('new_index');
  

- **刪除索引**
  ```javascript
  await mcp.deleteIndex('existing_index');

高級功能

異步任務

const taskId = await mcp.startTask('your_task_description');
await mcp.waitForTask(taskId);

日誌記錄

• 啟用日誌

  mcp.enableLogging(true);
  

- **查看日誌**
  ```javascript
  const logs = await mcp.fetchLogs();

整合指南

集成步驟

1. 安裝依賴：

   npm install meilisearch-mcp-server
   

2. 初始化模塊：

   const mcp = require('meilisearch-mcp-server');
   

3. 啟動服務：

   mcp.startServer(3000);
   

配置選項

mcp.configure({
  host: 'localhost',
  port: 3000,
  logging: true,
  api_key: 'your_api_key'
});

錯誤處理

常見錯誤

• 未找到索引

  mcp.getIndex('nonexistent_index').catch(err => console.error(err.message));
  

- **API 錯誤**
  ```javascript
  mcp.search('your_index', 'invalid_query').catch(err => console.error(err.status, err.data));

參考文檔

API 文檔

• MCP 服務器 API
• Meilisearch 官方文檔

社區資源

• GitHub 倉庫
• 討論論壇

📄 許可證

本項目遵循 MIT 協議，詳見 LICENSE 文件。

貢獻指南

歡迎 fork 和提交 Pull Request！