smar-mcp - 支持搜索、检索与更新，集成Smartsheet API的MCP服务器工具

探索

Smar MCP

一个基于Model Context Protocol (MCP)的Smartsheet API交互服务器，提供搜索、检索和更新Smartsheet表格的功能，支持版本备份和格式化响应。

开发者工具研究与数据 #表格管理 #API集成 #版本控制远程 .TypeScript

评分 : 2分

下载量 : 9.0K

更新时间 : 2025-04-28

打开站点

什么是Smartsheet MCP服务器？

Smartsheet MCP服务器是一个基于Model Context Protocol（MCP）的工具，允许用户通过简单的命令与Smartsheet API交互。它支持创建、更新和删除项目数据，还能生成历史版本备份。

如何使用Smartsheet MCP服务器？

只需几步即可开始操作：安装依赖、配置环境变量，然后启动服务器。您可以直接通过命令行或集成工具来执行任务。

适用场景

适用于需要频繁访问和管理Smartsheet项目的团队和个人，例如项目经理、业务分析师和技术开发者。

主要功能

获取项目详情

检索指定项目的当前状态，包括行、列和单元格数据。

创建历史版本备份

基于特定时间戳生成项目的快照备份。

更新行数据

修改现有项目的行内容、格式和公式。

删除行数据

删除指定行数据（需开启删除权限）。

优势

简化复杂API调用流程

支持实时历史版本管理

优化AI友好型响应格式

局限性

需要有效的Smartsheet API密钥

高级功能可能涉及额外配置

如何使用

克隆仓库

通过Git克隆Smartsheet MCP服务器代码。

安装依赖

运行npm命令安装所需依赖。

配置环境变量

在项目根目录创建.env文件并填写您的Smartsheet API密钥。

构建项目

编译代码以确保正常运行。

启动服务器

运行npm脚本启动MCP服务器。

使用案例

案例1：获取项目数据

通过get_sheet工具获取项目详情。

案例2：创建历史版本备份

根据特定时间戳创建项目的快照备份。

常见问题

如何获得Smartsheet API密钥？

是否支持多语言环境？

如何关闭删除行数据的功能？

🚀 智能 MCP 服务器：Smartsheet 集成

本项目打造了一个智能最小可行性产品（MCP）服务器，可与 Smartsheet 集成，还支持通过 Claude for Desktop 进行交互，为开发和集成工作带来便利。

🚀 快速开始

入门指南

环境变量配置
- 配置 SMARTSHEET_API_KEY 环境变量，用于 Smartsheet API 认证。
- 可选：设置 ALLOW_DELETE_TOOLS 为 'true' 启用删除操作，默认禁用。
安装依赖

npm install

运行开发环境

npm run dev

测试集成
- 参考 Claude Desktop Quickstart 进行本地测试。
- 使用 claude_desktop_config-example.json 作为配置模板，并根据需要调整环境变量。

✨ 主要特性

核心功能

直接 API 访问：借助 Smartsheet 直接 API 客户端实现对 Smartsheet 的操作。
工具定义：在 src/index.ts 中定义 MCP 工具，支持创建、读取、更新和删除数据等多种操作。
实用函数：提供通用操作的辅助函数，简化开发流程。

支持的操作

创建/读取/更新/删除 (CRUD)：可对 Smartsheet 项目、任务、评论等进行 CRUD 操作。
复杂工作流：能够实现复杂的业务逻辑和自动化工作流。
数据导出与导入：支持数据的批量导出和导入功能。

📦 安装指南

环境变量配置

配置 SMARTSHEET_API_KEY 环境变量，用于 Smartsheet API 认证。
可选：设置 ALLOW_DELETE_TOOLS 为 'true' 启用删除操作，默认禁用。

安装依赖

npm install

运行开发环境

npm run dev

💻 使用示例

基础用法

以下是一个使用 Smartsheet API 创建新项目的示例：

import { SmartsheetClient } from './src/smartsheet-direct-api';

const client = new SmartsheetClient(process.env.SMARTSHEET_API_KEY);

async function createProject() {
  const projectId = await client.createProject('My New Project');
  console.log(`Project created with ID: ${projectId}`);
}

createProject();

📚 详细文档

项目结构

smartsheet-mcp/
├── src/
│   ├── index.ts                   # 主入口点和 MCP 工具定义
│   ├── smartsheet-direct-api.ts    # 直接 API 客户端实现
│   ├── smartsheet-utils.ts         # 公共辅助函数
│   ├── smartsheet-workflows.ts     # 复杂工作流实现
│   └── smartsheet-types.ts        # Smartsheet 对象类表示
├── tests/
│   ├── unit/                     # 单元测试文件
│   └── integration/              # 集成测试文件
├── scripts/                      # 工具脚本
├── examples/                     # 示例用法文件
├── .env                          # 环境变量配置文件
├── .env.example                 # 环境变量模板
└── claude_desktop_config-example.json # 示例 Claude Desktop 配置文件

文档资源

官方文档：Smartsheet API 文档
项目 Wiki：查阅内部Wiki获取更多开发信息。
示例仓库：参考 examples/ 文件夹中的示例代码。

📄 许可证

项目使用 MIT License 开源协议，具体内容如下：

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

通过以上说明，您可以轻松上手并开始使用 Smartsheet MCP 服务器进行开发和集成。