使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在连接微软Azure AI Agent Service和Neon Serverless Postgres数据库。它允许用户通过自然语言指令,利用AI Agent管理Neon云平台的数据库服务。用户可以通过支持MCP协议的客户端(如Claude Desktop)与此服务器交互,间接使用Azure AI Agent来操作Neon数据库,例如创建项目、数据库等。

主要功能点

  • 连接Azure AI Agent Service: 作为MCP服务器,对接Azure AI Agent Service,利用Azure强大的AI能力。
  • Neon 数据库管理工具: 提供创建Neon项目、数据库等管理工具,并通过自然语言指令触发。
  • 自然语言操作界面: 用户可以使用自然语言通过MCP客户端指示AI Agent执行Neon数据库管理任务。
  • 可扩展性: 易于添加更多Neon数据库管理工具(如创建分支、用户角色管理等)。

安装步骤

  1. 克隆仓库
    git clone https://github.com/neondatabase-labs/mcp-neon-azure-ai-agent.git
    cd mcp-neon-azure-ai-agent
  2. 创建并激活虚拟环境
    python -m venv venv && source venv/bin/activate
  3. 安装依赖
    pip install -r requirements.txt
  4. 配置环境变量 在项目根目录下创建 '.env' 文件,并填入以下环境变量:
    PROJECT_CONNECTION_STRING=your_azure_project_connection_string  # 你的Azure AI项目连接字符串
    AZURE_OPENAI_CHAT_DEPLOYMENT_NAME=your_deployment_name         # 你的Azure OpenAI Chat部署名称 (例如 gpt4o)
    NEON_API_KEY=your_neon_api_key                                  # 你的Neon API密钥
    请替换 'your_azure_project_connection_string', 'your_deployment_name', 和 'your_neon_api_key' 为您实际的值。

服务器配置

要将此MCP服务器配置到MCP客户端(例如 Claude Desktop),您需要在客户端的配置文件中添加一个新的服务器配置。以下是 Claude Desktop 客户端配置 ('claude_desktop_config.json') 的示例配置信息,您需要根据实际情况修改文件路径:

{
    "mcpServers": {
      "azure-agent": {
        "command": "/ABSOLUTE/PATH/TO/neon-mcp-azure-ai-agent/venv/bin/python",
        "args": [
          "-m",
          "azure_agent_mcp_server"
        ],
        "cwd": "/ABSOLUTE/PATH/TO/neon-mcp-azure-ai-agent"
      }
    }
  }

配置参数说明:

  • '"azure-agent"': 服务器名称,您可以自定义,客户端通过此名称识别和连接服务器。
  • '"command"': MCP服务器启动命令。指向Python解释器,并执行 'azure_agent_mcp_server.py' 模块。请将 '/ABSOLUTE/PATH/TO/neon-mcp-azure-ai-agent' 替换为您的项目 绝对路径
  • '"args"': 启动参数。 '"-m azure_agent_mcp_server"' 表示以模块方式运行 'azure_agent_mcp_server.py' 文件。
  • '"cwd"': 工作目录。 设置为项目根目录的绝对路径,确保程序能找到相关的资源文件和环境变量。

注意: 环境变量 'PROJECT_CONNECTION_STRING', 'AZURE_OPENAI_CHAT_DEPLOYMENT_NAME', 'NEON_API_KEY' 应在服务器运行环境中正确配置,可以通过 '.env' 文件或系统环境变量设置。

基本使用方法

  1. 启动MCP服务器: 配置完成后,启动Claude Desktop客户端,MCP服务器将随客户端一同启动。
  2. 连接服务器: 在Claude Desktop客户端中,您应该能看到名为 '"azure-agent"' 的服务器已连接。
  3. 发送指令: 在Claude Desktop的输入框中,使用自然语言输入指令,例如:'Create a Neon database project named 'My MCP'.'
  4. 查看结果: AI Agent将处理您的指令,并尝试在Neon云平台上执行相应的数据库管理操作。执行结果将以文本形式返回在客户端界面。

后续步骤

您可以根据项目 "What's Next" 部分的提示,扩展更多Neon数据库管理工具,例如创建分支、数据库、执行SQL查询等,以丰富服务器的功能。

信息

分类

数据库与文件