使用说明

项目简介

Atlas DataHub MCP服务器是一个基于Model Context Protocol (MCP) 构建的后端应用，旨在为大型语言模型 (LLM) 客户端提供与Azure Cosmos DB数据库安全且高效的交互能力。通过实现MCP协议，该服务器允许LLM客户端以标准化的方式访问和操作存储在Azure Cosmos DB中的数据资源，扩展了LLM的功能边界，使其能够利用外部数据进行更丰富的上下文感知和任务执行。

主要功能点

Azure Cosmos DB 集成: 无缝连接Azure Cosmos DB，作为数据存储后端。
数据查询与管理: 提供工具支持对Azure Cosmos DB中的记录进行高效查询、插入和更新操作。
类型安全: 使用TypeScript开发，保证操作的类型安全和代码质量。
结构化元数据和上下文状态: 支持处理结构化元数据和维护Agent上下文状态。
兼容 MCP 客户端: 与 Cline, Cursor, Claude Desktop 以及任何其他 MCP 客户端兼容。

安装步骤

环境准备: 确保已安装 Node.js (v20 或更高版本) 和 npm。
安装 Atlas DataHub MCP 服务器: 在终端中运行以下命令即可通过 NPX 快速启动服务器：
```
npx -y atlas-datahub-mcp@latest
```
这将从 npm 下载并运行最新版本的 Atlas DataHub MCP 服务器。

服务器配置

要将 Atlas DataHub MCP 服务器配置到 MCP 客户端（例如 Cline, Cursor, Claude Desktop），您需要提供服务器的启动命令和相关参数。以下是通用的配置信息，您需要根据您的 Azure Cosmos DB 账号信息进行替换。

MCP 服务器配置 (JSON 格式):

{
  "your-server-name": {  // "your-server-name" 可以替换为您在 MCP 客户端中为该服务器自定义的名称，例如 "atlas-datahub"
    "command": "npx",
    "args": ["-y", "atlas-datahub-mcp@latest"],
    "env": {
      "AZURE_COSMOS_CONNECTION_STRING": "YOUR_COSMOS_DB_CONNECTION_STRING", // 替换为您的 Azure Cosmos DB 连接字符串
      "AZURE_COSMOS_DATABASE_NAME": "YOUR_DATABASE_NAME", // 替换为您的 Azure Cosmos DB 数据库名称
      "AZURE_COSMOS_CONTAINER_NAME": "YOUR_CONTAINER_NAME"  // 替换为您的 Azure Cosmos DB 容器名称
    }
  }
}

配置说明:

'"your-server-name"': 您在 MCP 客户端中为该服务器设置的名称，用于标识和管理服务器连接。
'"command": "npx"': 指定用于启动服务器的命令为 'npx'，它允许直接运行 npm 包，无需全局安装。
'"args": ["-y", "atlas-datahub-mcp@latest"]': 'npx' 命令的参数，'-y' 表示自动确认安装，'atlas-datahub-mcp@latest' 指定要运行的 npm 包及其版本（latest 表示最新版本）。
'"env"': 环境变量配置，用于传递 Azure Cosmos DB 的连接信息给服务器。
- '"AZURE_COSMOS_CONNECTION_STRING"': 必须替换 为您的 Azure Cosmos DB 账号的连接字符串，用于服务器连接到您的数据库实例。
- '"AZURE_COSMOS_DATABASE_NAME"': 必须替换 为您要访问的 Azure Cosmos DB 数据库名称。
- '"AZURE_COSMOS_CONTAINER_NAME"': 必须替换 为您要操作的 Azure Cosmos DB 容器名称。

请根据您使用的 MCP 客户端 (Cline, Cursor, Claude Desktop) 的具体配置方法，将以上 JSON 配置信息填入到客户端的 MCP 服务器设置中。具体的配置步骤可以参考 README.md 文件中对应客户端的配置指南。

基本使用方法

成功配置并启动 Atlas DataHub MCP 服务器后，在您的 MCP 客户端中，您可以使用自然语言指令来调用服务器提供的工具，与 Azure Cosmos DB 进行数据交互。

示例 (在 Claude Desktop App 中):

查询记录: 在 Claude Desktop App 中，您可以输入类似以下的指令来查询数据：

Query all records with partition key "user123" from the database.

插入记录: 使用以下指令插入新的记录：

Insert a new record with ID "doc123", partition key "user123", and data containing title and content.

更新记录: 更新现有记录的指令示例如下：

Update the record with ID "doc123" and partition key "user123" with new title and content.

请注意，具体的指令格式可能需要根据您使用的 MCP 客户端和工具的参数定义进行调整。您可以参考工具的描述信息或服务器的文档来获取更详细的指令用法。

关键词