MCP 服务器

Quickbase MCP Server

为通过 Claude 和其他 MCP 客户端与 Quickbase 的 JSON RESTful API 交互提供一个标准化的接口，支持诸如查询记录、管理表关系和处理文件附件等操作。

README

Quickbase MCP 连接器

一个用于集成 Quickbase JSON RESTful API 的模型上下文协议 (MCP) 连接器。

免责声明：这是一个非官方的独立项目，与 Quickbase, Inc. 无关联，未经其赞助或认可。此连接器按“原样”提供，不提供任何形式的保证，并且 Quickbase 不提供支持。用户在使用此连接器时，有责任遵守所有适用的法律、法规和安全要求。

概述

此连接器使用模型上下文协议 (MCP) 使 AI 助手（如 Claude）能够与 Quickbase 的 API 交互。它支持广泛的操作，用于管理 Quickbase 的应用程序、表、字段、记录、文件和报告。

功能

对于用户

AI 驱动的 Quickbase 访问: 直接通过 Claude 与您的 Quickbase 数据对话
数据管理: 通过自然语言创建、查看和更新您的应用程序、表和记录
文件处理: 上传和下载文件附件到您的记录
报告访问: 运行您的 Quickbase 报告，并在聊天中直接获取结果
大型数据集支持: 在查询大量记录时自动处理分页

对于开发者

全面的 API 覆盖: 访问核心 Quickbase API 功能
结构化响应: 一致的响应格式，便于可靠解析
批量操作: 高效处理批量记录操作
错误诊断: 详细的错误消息，包含状态代码和故障排除信息

前提条件

Python 3.8 或更高版本
Node.js 14 或更高版本
Quickbase API 凭据（realm 主机名、用户令牌和应用程序 ID）

安装

克隆存储库：

git clone https://github.com/danielbushman/Quickbase-MCP-connector.git
cd Quickbase-MCP-connector

设置环境：

./setup.sh

配置您的 Quickbase 凭据：

cp .env.example .env
# 编辑 .env 文件，填入您的凭据

快速开始

对于那些只想尝试使用 Claude 或 Claude Code 的连接器的人：

安装依赖项并设置服务器：

# 运行 setup 脚本以安装所有依赖项
./setup.sh

# 创建一个包含您的 Quickbase 凭据的 .env 文件
echo "QUICKBASE_REALM_HOST=your-realm.quickbase.com
QUICKBASE_USER_TOKEN=your_user_token_here
QUICKBASE_APP_ID=your_app_id_here" > .env

与 Claude Desktop 一起使用（推荐）：

为 Claude Desktop 创建一个配置文件，该文件会自动启动服务器。配置文件的位置取决于您的操作系统：

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

添加以下配置：

{
  "mcpServers": {
    "quickbase": {
      "command": "/path/to/node",
      "args": [
        "/path/to/Quickbase-MCP-connector/src/quickbase/server.js"
      ],
      "env": {
        "QUICKBASE_REALM": "your-realm",
        "QUICKBASE_USER_TOKEN": "your-user-token",
        "QUICKBASE_APP_ID": "your-app-id"
      }
    }
  }
}

与 Claude Code 一起使用：

# 这个命令既注册又启动 MCP 服务器
claude mcp add quickbase node src/quickbase/server.js

现在您可以在 Claude 会话中使用 Quickbase 工具了！示例提示： "使用 quickbase 连接器列出我的 Quickbase 应用程序中的所有表。"

可用工具类别

连接工具

test_connection: 验证您的 Quickbase API 连接
check_auth: 检查身份验证状态和权限

应用程序工具

get_app: 获取有关特定应用程序的详细信息
get_apps: 列出所有可用的应用程序
create_app, update_app: 创建和更新应用程序

表格工具

get_table, get_tables: 检索表格信息
create_table, update_table: 创建和更新表格

字段工具

get_field, get_fields: 检索字段信息
create_field, update_field: 创建和更新字段

记录工具

get_record, query_records: 检索记录数据
create_record, update_record: 单个记录操作
bulk_create_records, bulk_update_records: 高效的批量操作

文件工具

upload_file: 将文件上传到记录字段
download_file: 从记录字段下载文件
manage_attachments: 高级附件管理

报告工具

run_report: 执行 Quickbase 报告

未实现

以下操作未实现：

删除操作 (delete_app, delete_table, delete_field, delete_record, bulk_delete_records, delete_file)
用户操作 (get_user, get_current_user, get_user_roles, manage_users)
表单操作 (manage_forms)
仪表板操作 (manage_dashboards)
管道操作 (manage_pipelines)
FastField 表单操作 (manage_fast_field_form)

对于开发者和贡献者

手动启动 MCP 服务器

如果您需要手动启动服务器（用于开发或调试）：

node src/quickbase/server.js

运行测试

本节主要针对希望验证其更改或运行测试套件的贡献者。

所有测试都位于 tests/ 目录中。您可以使用测试运行器来运行特定测试或所有测试：

# 运行所有测试
python tests/run_tests.py --all

# 运行特定测试
python tests/run_tests.py connection pagination file

# 运行全面的验证脚本
python tests/run_tests.py validate

也可以直接运行单个测试脚本：

# 测试连接
python tests/test_connection.py

# 测试文件操作
python tests/test_file_operations.py

# 测试分页
python tests/test_pagination.py

有关测试的更多信息，请参见 tests/README.md。

环境变量

可能需要配置以下环境变量：

# Quickbase API 凭据
QUICKBASE_REALM_HOST=your-realm.quickbase.com
QUICKBASE_USER_TOKEN=your_user_token_here
QUICKBASE_APP_ID=your_app_id_here

# 用于文件操作测试
QUICKBASE_TABLE_ID=your_table_id_here
QUICKBASE_RECORD_ID=your_record_id_here
QUICKBASE_FILE_FIELD_ID=your_file_field_id_here

# MCP 服务器设置（可选）
MCP_SERVER_PORT=3535