Alibaba Cloud Lindorm

🚀 Lindorm MCP 服務端

此倉庫是一個如何為 Lindorm 創建 MCP 服務端的示例，Lindorm 是一個支持多模的 NoSQL 數據庫，能為用戶提供多樣化的數據存儲和處理能力。

🚀 快速開始

✨ 主要特性

• 多引擎支持：支持 Lindorm 的寬表引擎、搜索引擎、向量引擎和 AI 引擎。
• 便捷操作：提供一系列工具，可進行全文檢索、向量檢索、SQL 查詢等操作。

📦 安裝指南

Lindorm 上的配置

要利用此 MCP 服務端，請按照以下步驟操作：

1. 在 Alibaba Cloud 購買 Lindorm 的寬表引擎、搜索引擎、向量引擎和 AI 引擎。
2. 根據官方指南 部署一個文本嵌入模型。
3. 使用部署的嵌入式模型創建索引（知識庫）並導入數據。

環境搭建

1. 克隆此倉庫並進入項目目錄。
2. 創建你的環境文件：

cp .env.example .env

3. 根據具體需求編輯 .env 文件： | 屬性 | 詳情 | |------|------| | LINDORM_INSTANCE_ID | 你的 Lindorm 實例 ID | | USING_VPC_NETWORK | 如果在 VPC 網絡上運行設置為 true，否則 false | | USERNAME | 你的 Lindorm 賬戶用戶名 | | PASSWORD | 你的 Lindorm 賬戶密碼 | | TEXT_EMBEDDING_MODEL | 部署的文本嵌入模型名稱 | | TABLE_DATABASE | 執行 SQL 操作的數據庫 |

注意：此配置假設所有引擎共享相同的用戶名和密碼。

運行 MCP 服務端

你需要安裝 uv。 直接啟動 MCP 服務端。

cd /path/to/alibabacloud-lindorm-mcp-server/

uv pip install .

uv run python -m src.lindorm_mcp_server.server

Visual Studio Code

1. 安裝 Cline 擴展。
2. 在 /path/to/alibabacloud-lindorm-mcp-server/ 下創建 .env 文件。
3. 從 .vscode/mcp.json 複製 MCP 配置到 cline_mcp_settings.json，根據需要替換路徑和變量。
4. 使用 Cline 擴展啟動 MCP 服務端。

💻 使用示例

基礎用法

以下是使用 lindorm_retrieve_from_index 工具從現有索引中檢索信息的示例：

# 假設已經安裝並配置好環境
from some_module import lindorm_retrieve_from_index

result = lindorm_retrieve_from_index(
    index_name="your_index_name",
    query="your_query_content",
    content_field="your_content_field",
    vector_field="your_vector_field",
    top_k=10
)
print(result)

📚 詳細文檔

組件

• LindormVectorSearchClient：在搜索和向量引擎上執行全文檢索和向量檢索。
• LindormWideTableClient：對 Lindorm 寬表執行 SQL 操作。

可用工具

• lindorm_retrieve_from_index：從現有索引（或知識庫）中使用全文檢索和向量檢索，並返回聚合結果。
  • 參數：
    • index_name：索引名稱，即知識庫名稱
    • query：要在知識庫中搜索的查詢內容
    • content_field：存儲內容文本的字段。你可以從索引結構中通過 lindorm_get_index_mappings 工具獲取
    • vector_field：存儲向量索引的字段。你可以從索引結構中通過 lindorm_get_index_mappings 工具獲取
    • top_k：要返回的結果數量
• lindorm_get_index_fields：獲取索引（或知識庫）的字段信息，特別是獲取存儲向量和內容的字段。
  • 參數：
    • index_name：索引名稱，即知識庫名稱
• lindorm_list_all_index：列出所有索引（或知識庫）。
• lindorm_execute_sql：在 Lindorm 數據庫上執行 SQL 查詢。
  • 參數
    • query：以 select 開頭的要執行的 SQL 查詢
• lindorm_show_tables：獲取 Lindorm 數據庫中的所有表
• lindorm_describe_table：獲取 Lindorm 數據庫中表的模式信息
  • 參數：
    • table_name：表名稱