使用说明

项目简介

MCP-Nhost 是一个 Model Context Protocol (MCP) 服务器的实现，它为 Nhost Cloud 项目提供了一个统一的接口。通过 MCP 协议，客户端可以安全、标准化地访问和操作 Nhost Cloud 的各项服务，例如获取 GraphQL Schema、执行 GraphQL 查询等。MCP-Nhost 旨在简化 LLM 应用与 Nhost 后端的集成，提供便捷的上下文服务。

主要功能点

Nhost 云平台集成：无缝连接 Nhost Cloud 项目，实现云端项目管理和配置。
本地项目支持：同样支持本地 Nhost 开发项目，方便本地开发和测试。
GraphQL Schema 感知：提供工具获取 Nhost Cloud 和本地项目的 GraphQL Schema，帮助开发者理解数据结构和可用操作。
GraphQL 查询执行：允许客户端通过工具执行 GraphQL 查询和 Mutation，与 Nhost 项目数据进行交互。

安装步骤

打开终端，复制并执行以下命令来安装 MCP-Nhost：

sudo curl -L https://raw.githubusercontent.com/nhost/mcp-nhost/main/get.sh | bash

此命令将自动下载并安装 MCP-Nhost 服务器到您的系统中。

服务器配置

MCP 客户端（如 Cursor）需要配置 MCP 服务器的启动命令和参数才能连接。以下是一个 Cursor 客户端的 MCP 服务器配置示例，您可以根据需要进行调整：

{
  "mcpServers": {
    "mcp-nhost": {
      "command": "/usr/local/bin/mcp-nhost",
      "args": [
        "start",
        "--with-cloud-mutations",
        "--project-subdomain=<您的Nhost项目子域名>",
        "--project-region=<您的Nhost项目区域>",
        "--project-admin-secret=<您的Nhost项目管理员密钥>",
        "--project-allow-queries=*",
        "--project-allow-mutations=*"
      ],
      "env": {
        "NHOST_PAT": "<您的Nhost个人访问令牌>"
      }
    }
  }
}

参数说明:

command: MCP-Nhost 服务器的启动命令，通常是安装路径 '/usr/local/bin/mcp-nhost'。
args: 启动参数列表，用于配置 MCP-Nhost 服务器的功能和连接信息：
- 'start': 指定 MCP-Nhost 服务器启动 'start' 命令。
- '--with-cloud-mutations': 启用云项目 Mutation 功能。
- '--project-subdomain=<您的Nhost项目子域名>': 您的 Nhost 项目子域名，请替换为您的实际项目子域名。
- '--project-region=<您的Nhost项目区域>': 您的 Nhost 项目区域，请替换为您的实际项目区域。
- '--project-admin-secret=<您的Nhost项目管理员密钥>': 您的 Nhost 项目管理员密钥，用于云项目管理，请替换为您的实际管理员密钥。
- '--project-allow-queries=*': 允许所有 GraphQL 查询。
- '--project-allow-mutations=*': 允许所有 GraphQL Mutation。
env: 环境变量配置：
- 'NHOST_PAT': 您的 Nhost 个人访问令牌 (Personal Access Token)，用于身份验证，请替换为您的实际 PAT。

基本使用方法

安装 MCP-Nhost 服务器：按照上述安装步骤完成安装。
配置 Cursor 客户端：在 Cursor 的 MCP 设置中，添加上述 JSON 配置，并替换 '<您的Nhost项目子域名>'、'<您的Nhost项目区域>'、'<您的Nhost项目管理员密钥>' 和 '<您的Nhost个人访问令牌>' 为您的实际信息。
创建 Nhost 个人访问令牌 (PAT)：访问 Nhost 控制台 (https://app.nhost.io/account) 创建个人访问令牌，并将其填入 Cursor 客户端配置的 'NHOST_PAT' 环境变量中。
在 Cursor 中使用 MCP 功能：配置完成后，Cursor 客户端即可通过 MCP 协议与 MCP-Nhost 服务器通信，并利用其提供的工具和资源。例如，您可以使用 'cloud-get-graphql-schema' 工具获取 Nhost Cloud 的 GraphQL Schema，并使用 'cloud-graphql-query' 工具执行 GraphQL 查询。

更多高级用法和配置选项，请参考仓库中的 'USAGE.md' 文档和 CLI 帮助信息 ('mcp-nhost --help')。

关键词

使用说明

信息