Glide API MCP Server 使用说明

项目简介

Glide API MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 LLM 应用提供访问和操作 Glide 应用数据的能力。通过标准化的 MCP 协议，LLM 客户端可以安全、便捷地与 Glide API 进行交互，实现数据读取、写入和更新等操作。

主要功能点

支持 Glide API v1 和 v2: 兼容 Glide API 的两个主要版本。
工具化数据访问: 提供一系列预定义的工具，方便 LLM 客户端获取应用信息、表格列表、表格数据以及管理表格行。
安全 API 密钥管理: 推荐使用环境变量配置 API 密钥，保障敏感信息安全。同时也支持在运行时通过工具动态设置 API 密钥。
类型安全: 使用 TypeScript 开发，提高代码质量和可维护性。
错误处理: 提供全面的错误处理机制，确保服务器稳定运行。

可用工具 (Tools):

'set_api_version': 设置 Glide API 版本和 API 密钥。
'get_app': 获取应用信息。
'get_tables': 获取应用中的表格列表。
'get_table_rows': 获取表格中的数据行。
'add_table_row': 在表格中添加新的数据行。
'update_table_row': 更新表格中已有的数据行。

安装步骤

安装 Node.js 和 npm: 确保你的开发环境中已安装 Node.js 和 npm (Node 包管理器)。

克隆仓库: 将仓库 'https://github.com/knmurphy/glide-api-mcp-server' 克隆到本地。

git clone https://github.com/knmurphy/glide-api-mcp-server
cd glide-api-mcp-server

安装依赖: 在仓库根目录下运行以下命令安装项目依赖。
```
npm install
```
构建项目: 运行以下命令构建项目，生成可执行文件。
```
npm run build
```
构建成功后，会在 'build' 目录下生成 'index.js' 文件。

服务器配置

为了让 MCP 客户端能够连接到 Glide API MCP Server，需要在 MCP 客户端的配置文件中添加服务器配置信息。以下是一个示例配置，请根据实际情况修改：

{
  "mcpServers": {
    "glide-api": {
      "command": "node",
      "args": ["path/to/build/index.js"],
      "env": {
        "GLIDE_API_KEY": "YOUR_GLIDE_API_KEY",  // 替换为你的 Glide API 密钥
        "GLIDE_API_VERSION": "v2"  // 可选，指定 Glide API 版本，默认为 v2，可选 "v1"
      }
    }
  }
}

配置参数说明:

'server name': 'glide-api' (服务器名称，客户端通过此名称引用)
'command': 'node' (启动服务器的命令，这里使用 Node.js 运行 JavaScript 文件)
'args': '["path/to/build/index.js"]' (命令参数，指向构建后的服务器入口文件。请根据实际路径填写，如果 MCP 客户端的工作目录与仓库根目录一致，可以使用 '"build/index.js"' )
'env': (环境变量配置)
- 'GLIDE_API_KEY': 必填，你的 Glide API 密钥。请替换 '"YOUR_GLIDE_API_KEY"' 为你的实际密钥。强烈建议使用环境变量方式配置 API 密钥，避免密钥泄露。
- 'GLIDE_API_VERSION': 可选，指定 Glide API 版本，可选值为 '"v1"' 或 '"v2"'，默认为 '"v2"'。如果未配置，服务器将默认使用 v2 版本。

注意:

请将 'YOUR_GLIDE_API_KEY' 替换为你自己的 Glide API 密钥。
'path/to/build/index.js' 需要根据实际情况调整为 'build/index.js' 或其他正确的相对或绝对路径。

基本使用方法

启动 MCP 服务器: 配置完成后，当 MCP 客户端尝试连接 'glide-api' 服务器时，会自动根据配置启动该服务器。

使用 MCP 工具: 在 LLM 应用或 MCP 客户端中，可以使用 'use_mcp_tool' 等方法调用 Glide API MCP Server 提供的工具。例如，获取应用信息的示例代码如下 (伪代码，实际使用方式取决于 MCP 客户端 SDK)：

use_mcp_tool({
  server_name: "glide-api",
  tool_name: "get_app",
  arguments: {
    appId: "YOUR_APP_ID"  // 替换为你的 Glide App ID
  }
});

请参考仓库 'README.md' 文件和 MCP 客户端 SDK 的文档，了解更多工具的使用方法和参数。

API 密钥和版本运行时配置:

除了环境变量，你还可以使用 'set_api_version' 工具在运行时动态设置 API 密钥和版本。例如：

use_mcp_tool({
  server_name: "glide-api",
  tool_name: "set_api_version",
  arguments: {
    version: "v1",  // 设置为 v1 版本
    apiKey: "YOUR_RUNTIME_API_KEY" // 运行时设置的 API 密钥
  }
});

注意: 运行时配置的 API 密钥和版本只在当前会话中有效，会覆盖环境变量的配置。

关键词