项目介绍
Lindorm MCP 服务器
此仓库是一个如何为 Lindorm(一种多模型 NoSQL 数据库)创建 MCP 服务器的示例。
使用方法
在 Lindorm 上的配置
要使用此 MCP 服务器,请按照以下步骤操作:
- 在 阿里云 购买 Lindorm 宽表引擎、搜索引擎、向量引擎和 AI 引擎。
- 按照 官方指南 部署一个文本嵌入模型。
- 创建您的索引(知识库),并使用已部署的嵌入模型导入数据。
环境设置
- 克隆此仓库并导航到项目目录。
- 创建环境文件:
cp .env.example .env
- 编辑 .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
- 安装 Cline 扩展。
- 在
/path/to/alibabacloud-lindorm-mcp-server/ 下创建 .env 文件。
- 将 .vscode/mcp.json 中的 MCP 配置复制到 cline_mcp_settings.json,并根据需要替换路径和变量。
- 通过 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: 列出您拥有的所有索引(或知识库)。
- `l_执行 SQL 查询
- 参数
- query: 要执行的 SQL 查询,必须以 select 开头
lindorm_show_tables: 获取 Lindorm 数据库中的所有表
lindorm_describe_table: 获取 Lindorm 数据库中的表模式