Quickbase

🚀 Quickbase MCP 连接器

Quickbase MCP 连接器是一个非官方项目，可将 AI 助手（如Claude）与 Quickbase 的 JSON RESTful API 集成。它能帮助用户借助模型上下文协议（MCP）与 Quickbase 数据交互，提供数据管理、文件处理等功能。不过该项目不受 Quickbase 官方支持，使用时需谨慎。

🚀 快速开始

Quickbase MCP 连接器旨在助力用户通过模型上下文协议（MCP）与 Quickbase 的数据进行交互。使用前需确保具备相应的环境和凭证，安装完成后即可快速上手使用。

✨ 主要特性

用户功能

• 数据管理：支持 CRUD 操作（创建、读取、更新和删除）。
• 文件处理：提供文件的上传和下载功能。
• 报告执行：能够运行 Quickbase 的预定义报告。

开发者功能

• API 覆盖范围：全面覆盖 Quickbase 的主要 API 接口，包括数据操作、文件管理和报告执行。
• 错误处理：提供详细的错误分类和诊断信息，帮助开发者快速定位问题。
• 参数验证：确保输入的合法性和有效性。

📦 安装指南

克隆仓库

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

运行设置脚本

python setup.py

配置环境变量

在项目根目录下创建一个 env_config 文件，内容如下：

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

💻 使用示例

基础用法

使用 Claude Desktop

1. 配置 MCP 服务器：

export MCP_SERVER_PORT=3535
node src/quickbase/server.js

2. 在终端运行：

mcp-client -p 3535 --action list-apps

使用 Claude Code

import {MCPClient} from 'quickbase-mcp';
const client = new MCPClient({
  realm: 'your-realm',
  token: 'your-token'
});
await client.listApps();

📚 详细文档

工具类别

连接测试

• test-connection：验证服务器是否正常运行。

数据操作

• list-apps：获取所有应用。
• get-app-details：获取指定应用的详细信息。
• query-data：执行数据查询。

文件操作

• upload-file：上传文件到指定记录字段。
• download-file：下载指定记录字段中的文件。

报告执行

• run-report：执行预定义的报告并获取结果。

未实现的功能

目前尚未实现以下功能：

• 删除操作：包括删除应用、表单、字段和记录等。
• 用户管理：无法获取或修改用户信息及权限。
• 表单管理：不支持表单的相关操作。
• 仪表盘管理：无法管理仪表盘。
• 数据流管理：不支持管道操作。

开发者指南

手动启动服务器

node src/quickbase/server.js

运行测试

所有测试位于 tests/ 目录中：

python tests/run_tests.py

错误处理

常见错误

• 身份验证失败：请检查令牌是否正确。
• 权限不足：确保用户有足够的权限访问目标资源。

详细日志

所有操作都会记录详细的日志，便于排查问题。

声明

本项目仅为个人或社区开发用途，不保证稳定性或兼容性。使用前请仔细阅读相关文档和条款。

先决条件

使用 Quickbase MCP 连接器需要以下环境：

• Python 3.6+ 和 Node.js 14+
• 必须提供有效的 Quickbase 凭证，包括：
  • QUICKBASE_REALM_HOST：你的 Quickbase 实例地址。
  • QUICKBASE_USER_TOKEN：用于身份验证的用户令牌。
  • QUICKBASE_APP_ID：目标应用的唯一标识符。

结语

Quickbase MCP 连接器为您提供了一个强大的工具集，用于与 Quickbase 数据进行交互。无论你是开发者还是数据管理员，都能通过此连接器高效地管理和分析数据。

⚠️ 重要提示

此项目不受 Quickbase 官方支持，使用过程中请谨慎操作，并自行承担风险。

💡 使用建议

使用前请仔细阅读相关文档和条款，确保提供有效的 Quickbase 凭证。