项目简介

Amplify Data API MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在通过自然语言与 AWS Amplify Gen2 应用的数据进行交互。它允许用户使用类似 Claude 这样的 AI 助手,以对话的方式查询、修改和探索存储在 AWS Amplify Gen2 后端的数据模型,无需编写复杂的代码或命令。

主要功能点

  • 自然语言交互: 使用日常语言提问和发出指令,AI 助手会解析您的意图并操作数据。
  • 查看数据模型信息: 列出所有数据模型,查看模型字段详情,探索模型之间的关系。
  • 数据查询: 执行自定义 GraphQL 查询,检索和列表显示您的数据记录。
  • 数据修改: 通过 GraphQL mutation 创建、更新和删除数据记录。
  • 安全认证: 使用 Cognito 认证,确保只有授权用户才能访问数据。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/dbsmith7491/aws-amplify-data-mcp.git
    cd aws-amplify-data-mcp
  2. 安装依赖:
    npm install
  3. 构建项目:
    npm run build

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,您需要配置客户端以连接到此服务器。以下是 Claude Desktop 的配置示例,您需要将其添加到 Claude Desktop 的配置文件 'claude_desktop_config.json' 中。

{
  "mcpServers": {
    "amplify-data-api": {  // 服务器名称,客户端使用此名称来标识和调用该服务器
      "command": "node",  // 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件
      "args": [
        "/ABSOLUTE/PATH/TO/aws-amplify-data-mcp/build/index.js",  // MCP 服务器入口文件 build/index.js 的绝对路径,请替换为您的实际路径
        "--amplify-outputs",  // 传递给服务器的参数,指定 amplify_outputs.json 文件的路径
        "/ABSOLUTE/PATH/TO/YOUR/amplify_outputs.json" // 您的 amplify_outputs.json 文件的绝对路径,请替换为您的实际路径
      ],
      "env": {  // 环境变量配置
        "AMPLIFY_USERNAME": "your-admin-username",  // (可选) 用于自动登录的 Cognito 用户名,建议配置管理员用户
        "AMPLIFY_PASSWORD": "your-admin-password"   // (可选) 用于自动登录的 Cognito 密码,建议配置管理员用户
      }
    }
  }
}

请务必替换配置中的 '/ABSOLUTE/PATH/TO/aws-amplify-data-mcp' 和 '/ABSOLUTE/PATH/TO/YOUR/amplify_outputs.json' 为您本地文件系统的实际绝对路径。 如果您希望服务器在启动时自动登录 Cognito,请配置 'AMPLIFY_USERNAME' 和 'AMPLIFY_PASSWORD' 环境变量。

基本使用方法

配置完成后,在 MCP 客户端(如 Claude Desktop)中,您可以使用 '@amplify-data-api' 标签引导 AI 助手与此 MCP 服务器进行交互。例如:

  • '@amplify-data-api 我有哪些数据模型?' - 查询应用中的数据模型列表。
  • '@amplify-data-api 显示 Story 模型有哪些字段' - 查看 Story 模型的字段详情。
  • '@amplify-data-api 列出所有故事' - 查询并列出所有 Story 数据记录。
  • '@amplify-data-api 创建一个名为“探险之旅”的新故事' - 创建一个新的 Story 数据记录。

更多使用示例和可用工具,请参考仓库的 README.md 文件。

信息

分类

数据库与文件