Quickbase MCP 连接器项目文档

项目简介

Quickbase MCP 连接器是一个用于与 Quickbase 平台交互的工具，支持通过 Model Context Protocol (MCP) 协议与 AI 助手（如Claude）集成。该连接器提供了一系列功能，包括数据管理、文件操作和报告执行等。

免责声明

本项目并非官方的 Quickbase 产品或服务，也未得到任何官方支持。Quickbase 是一个注册商标，其版权归相关公司所有。

概述

Quickbase MCP 连接器旨在帮助用户通过 AI 助手管理 Quickbase 数据。它支持 CRUD 操作（创建、读取、更新、删除），并提供对文件操作和报告执行的功能。

特性

用户功能

• 数据管理：允许用户创建、读取、更新和删除数据。
• 文件操作：支持上传、下载和管理附件。
• 报告执行：能够运行 Quickbase 报告。

开发者功能

• 扩展性：开发者可以轻松添加自定义功能模块。
• 错误处理：提供详细的错误信息和解决方案建议。

安装要求

• 操作系统：支持 Linux、macOS 和 Windows。
• 依赖项：
  • Python 3.8 或更高版本
  • Node.js 14 或更高版本
• 凭证：需要 Quickbase 用户令牌和应用 ID。

安装指南

步骤 1: 克隆仓库

git clone https://github.com/your-repository.git
cd your-repository

步骤 2: 设置环境变量

在项目根目录下创建 .env 文件：

QUICKBASE_REALM_HOST=your-realm.quickbase.com
QUICKBASE_USER_TOKEN=your_user_token_here
QUICKBASE_APP_ID=your_app_id_here

步骤 3: 安装依赖

安装 Python 和 Node.js 依赖：

pip install -r requirements.txt
npm install

快速上手

配置 Quickbase Desktop

1. 打开终端，运行以下命令启动 MCP 服务器：

   node src/quickbase/server.js
   

2. 在浏览器中访问 http://localhost:3535。

使用 Claude Code

1. 设置环境变量：

   export QUICKBASE_TABLE_ID=your_table_id_here
   export QUICKBASE_RECORD_ID=your_record_id_here
   export QUICKBASE_FILE_FIELD_ID=your_file_field_id_here
   

2. 启动服务器并连接到 Quickbase。

功能模块

数据管理工具

• 创建数据：通过 API 发送 POST 请求。
• 查询数据：支持 GET 请求获取数据。
• 更新数据：使用 PATCH 或 PUT 方法更新数据。
• 删除数据：支持 DELETE 请求。

文件操作

• 上传文件：将文件附加到指定字段。
• 下载文件：通过 URL 下载附件。
• 管理附件：添加、删除或替换附件。

报告执行

• 运行报告：触发 Quickbase 报告并获取结果。
• 处理输出：解析报告输出进行后续操作。

环境变量

以下是项目所需的环境变量及其作用：

错误处理

错误类型

• 输入错误：参数格式不正确。
• 授权错误：无效令牌或权限不足。
• 网络错误：无法连接到 Quickbase 服务。

处理方法

• 检查日志文件以获取详细错误信息。
• 确保凭证和环境变量设置正确。
• 网络问题时，检查互联网连接。

贡献指南

欢迎社区参与项目开发！以下是贡献步骤：

1. Fork 仓库：在 GitHub 上 Fork 该项目。
2. 创建分支：为新功能或修复创建新的分支。
3. 提交更改：提交代码更改并添加详细说明。
4. 生成 Pull Request：将你的分支推送到原仓库以创建 PR。

许可证

本项目遵循 MIT 许可证，具体内容如下：

MIT License

如需进一步了解，请访问我们的 GitHub 仓库或联系维护团队。