使用说明

项目简介

Gridly MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器，专门为 Gridly API 提供服务。它允许LLM客户端通过标准化的MCP接口，调用预定义的工具来操作和查询 Gridly 中的项目、数据库、表格、视图、列和依赖项等资源。

主要功能点

项目管理:
- 列出项目 (list_projects)
- 获取项目详情 (retrieve_project)
数据库管理:
- 列出数据库 (list_databases)
- 获取数据库详情 (retrieve_database)
表格 (Grid) 管理:
- 获取表格详情 (retrieve_grid)
- 创建表格 (create_grid)
- 更新表格 (update_grid)
- 删除表格 (delete_grid)
视图 (View) 管理:
- 获取视图详情 (retrieve_view)
- 创建视图 (create_view)
列 (Column) 管理:
- 获取列详情 (retrieve_column)
- 创建列 (create_column)
- 删除列 (delete_column)
依赖项 (Dependency) 管理:
- 列出依赖项 (list_dependencies)
- 获取依赖项详情 (retrieve_dependency)
- 删除依赖项 (delete_dependency)

安装步骤

克隆仓库

git clone [email protected]:sangcnguyen/gridly-mcp-server.git
cd gridly-mcp-server

安装依赖
```
npm install
```
构建服务器
```
npm run build
```
构建成功后，在 'build' 目录下会生成 'index.js' 文件。

配置 MCP 客户端 以 Claude Desktop 为例，编辑 'claude_desktop_config.json' 文件 (如果还没有 Claude desktop，请先下载安装)。在 'mcpServers' 中添加 'gridly-server' 配置：

{
  "mcpServers": {
    "gridly-server": {
      "command": "node",
      "args": ["path/to/your/built/index.js"], // 请替换为build目录下index.js的绝对路径
      "env": {
        "GRIDLY_API_KEY": "your_api_key_here" // 请替换为你的Gridly API Key
      }
    }
  }
}

注意:

'args' 字段中的 'path/to/your/built/index.js' 需要替换为 步骤3 构建后生成的 'build/index.js' 文件的 绝对路径。
'env' 字段中的 'GRIDLY_API_KEY' 需要替换为你的 Gridly API 密钥。你需要在 Gridly 平台获取 API 密钥。

服务器配置

MCP 客户端需要配置以下信息以连接到 Gridly MCP Server：

{
  "mcpServers": {
    "gridly-server": { // 服务器名称，客户端配置中引用此名称
      "command": "node", // 启动服务器的命令，这里使用 node.js 运行时
      "args": ["path/to/your/built/index.js"], // 命令参数，指向构建后的 index.js 文件路径
      "env": {
        "GRIDLY_API_KEY": "your_api_key_here" // 环境变量，用于传递 Gridly API 密钥
      }
    }
  }
}

基本使用方法

启动 MCP 客户端 (如 Claude Desktop)。
客户端会根据配置连接到 Gridly MCP Server。
在客户端中，你可以指示 LLM 调用 Gridly MCP Server 提供的工具来操作 Gridly 数据。例如，你可以要求 Claude 列出你的 Gridly 项目，或者创建一个新的表格。
LLM 客户端会根据你的指令，调用相应的工具，并将结果返回给你。

示例对话 (在 Claude Desktop 中):

用户: 列出我的 Gridly 项目 Claude: (调用 'gridly-server' 的 'list_projects' 工具) ... (返回项目列表)

用户: 创建一个名为 "My Tasks" 的表格在数据库 "mydatabaseid" 中 Claude: (调用 'gridly-server' 的 'create_grid' 工具，参数为数据库ID和表格名称) ... (返回创建结果)

请参考 Model Context Protocol 官方文档和 Gridly API 文档了解更多细节。

关键词