# aliyun
## 基本信息
- Slug: `aliyun-alibabacloud-lindorm-mcp-server`
- Source: modelscope
- Publisher: @aliyun/alibabacloud-lindorm-mcp-server
- Categories: vector-databases / databases / search
- Hosted: No
- License: Apache License 2.0
- Source URL: https://www.modelscope.cn/mcp/servers/@aliyun/alibabacloud-lindorm-mcp-server
## 简介
暂无描述。
## MCP Server 详情

# Lindorm MCP 服务器
本仓库展示了如何为Lindorm（一个多模型NoSQL数据库）创建一个MCP服务器。

# 使用方法
## 在Lindorm上的配置
要使用此MCP服务器，请按照以下步骤操作：
1. 在[阿里云](https://common-buy.aliyun.com/?commodityCode=hitsdb_lindormpre_public_cn&regionId=cn-beijing)上购买Lindorm宽表引擎、搜索引擎、向量引擎和AI引擎。
2. 按照[官方指南](https://help.aliyun.com/zh/lindorm/user-guide/model-management-1)部署文本嵌入模型。
3. 创建您的索引（知识库），并使用已部署的嵌入模型导入数据。

## 环境设置
1. 克隆此仓库并导航到项目目录。
2. 创建环境文件：
   shell
   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服务器。
shell
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服务器。

# 组件
* `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: 要执行的SQL查询，以select开头
* `lindorm_show_tables`: 获取Lindorm数据库中的所有表
* `lindorm_describe_table`: 获取Lindorm数据库中表的模式
  * 参数
    * table_name: 表名