README
🚀 Gridly MCP 服务器
Gridly MCP 服务器是一款强大的工具,它提供了管理项目、网格、数据库等功能,帮助用户高效地进行数据管理和项目操作。
🚀 快速开始
在使用 Gridly MCP 服务器之前,需要完成以下准备工作:
- 安装 Claude Desktop 或任何支持 MCP 服务器的 MCP 客户端。
- 获取 Gridly API 密钥。
📦 安装指南
方法 1: 使用 npx(推荐)
此方法简单便捷,适合大多数用户。具体步骤如下:
- 打开 Claude Desktop 应用,依次点击设置 > 开发者 > 编辑配置。
- 编辑
claude_desktop_config.json文件,添加以下配置:
{
"mcpServers": {
"gridly-server": {
"command": "npx",
"args": ["-y", "gridly-mcp-server"],
"env": {
"GRIDLY_API_KEY": "your_api_key_here"
}
}
}
}
方法 2: 开发安装(针对开发者)
若你是开发者,需要对服务器进行定制开发,可采用此方法。步骤如下:
- 克隆仓库:
git clone git@github.com:sangcnguyen/gridly-mcp-server.git
- 安装依赖项:
npm install
- 构建服务器:
npm run build
注意在 dist 文件夹中的 index.js 文件,请复制其绝对路径并在步骤 4 的 args 中粘贴。
4. 打开 Claude Desktop 应用,依次点击设置 > 开发者 > 编辑配置。
5. 编辑 claude_desktop_config.json 文件,添加以下配置:
{
"mcpServers": {
"gridly-server": {
"command": "node",
"args": ["path/to/dist/folder/index.js"],
"env": {
"GRIDLY_API_KEY": "your_api_key_here"
}
}
}
}
📚 详细文档
可用工具
项目
list_projects:列出数据库中的网格。retrieve_project:获取一个项目。
数据库
list_databases:列出项目中的数据库。retrieve_database:获取一个数据库。
网格
retrieve_grid:列出数据库中的网格。create_grid:创建一个网格。update_grid:更新数据库中的网格。delete_grid:删除数据库中的网格。
视图
retrieve_view:获取现有视图。create_view:创建协作视图。
列
retrieve_column:获取一列。create_column:创建一列。delete_column:删除一列。add_column_to_view:将现有网格中的列添加到视图。remove_column_from_view:从视图中移除一列。
依赖项
list_dependencies:列出依赖项。retrieve_dependency:获取一个依赖项。delete_dependency:删除一个依赖项。
记录
add_records:向视图添加新记录。delete_records:删除视图中的现有记录。list_records:列出视图中的记录。get_record_history:获取视图中记录的历史记录。
Scan to contact