Quickbase MCP Server

by danielbushman
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Requires Node.js 14 or higher as a prerequisite for running the MCP server that connects to the Quickbase API.

Quickbase MCP 连接器

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

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

概述

该连接器使用模型上下文协议 (MCP) ,使 Claude 等 AI 助手能够与 Quickbase 的 API 交互。它支持使用 Quickbase 管理应用程序、表格、字段、记录、文件和报告的各种操作。

特征

对于用户

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

对于开发人员

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

先决条件

  • Python 3.8 或更高版本
  • Node.js 14 或更高版本
  • Quickbase API 凭证(领域主机名、用户令牌和应用程序 ID)

安装

  1. 克隆存储库:
git clone https://github.com/danielbushman/Quickbase-MCP-connector.git cd Quickbase-MCP-connector
  1. 设置环境:
./setup.sh
  1. 配置您的 Quickbase 凭据:
cp .env.example .env # Edit .env with your credentials

快速入门

对于那些只想尝试将此连接器与 Claude 或 Claude Code 一起使用的人:

  1. 安装依赖项并设置服务器:
# Run the setup script to install all dependencies ./setup.sh # Create a .env file with your Quickbase credentials echo "QUICKBASE_REALM_HOST=your-realm.quickbase.com QUICKBASE_USER_TOKEN=your_user_token_here QUICKBASE_APP_ID=your_app_id_here" > .env
  1. 与 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" } } } }
  1. 与 Claude 代码一起使用:
# This single command both registers and starts the MCP server claude mcp add quickbase node src/quickbase/server.js

现在,您可以在 Claude 会话中使用 Quickbase 工具了!示例提示:“使用 Quickbase 连接器列出我的 Quickbase 应用中的所有表格。”

可用工具类别

连接工具

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

应用工具

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

表格工具

  • get_tableget_tables :检索表信息
  • create_tableupdate_table :创建和更新表

现场工具

  • get_fieldget_fields :检索字段信息
  • create_fieldupdate_field :创建和更新字段

记录工具

  • get_recordquery_records :检索记录数据
  • create_recordupdate_record :单个记录操作
  • bulk_create_recordsbulk_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/目录中。您可以使用测试运行器来运行特定测试或所有测试:

# Run all tests python tests/run_tests.py --all # Run specific tests python tests/run_tests.py connection pagination file # Run the comprehensive validation script python tests/run_tests.py validate

单独的测试脚本也可以直接运行:

# Test connection python tests/test_connection.py # Test file operations python tests/test_file_operations.py # Test pagination python tests/test_pagination.py

有关测试的更多信息,请参阅tests/README.md

环境变量

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

# Quickbase API Credentials QUICKBASE_REALM_HOST=your-realm.quickbase.com QUICKBASE_USER_TOKEN=your_user_token_here QUICKBASE_APP_ID=your_app_id_here # For file operation testing QUICKBASE_TABLE_ID=your_table_id_here QUICKBASE_RECORD_ID=your_record_id_here QUICKBASE_FILE_FIELD_ID=your_file_field_id_here # MCP Server Settings (optional) MCP_SERVER_PORT=3535

错误处理

该连接器提供全面的错误处理功能:

  • 错误类型分类
  • HTTP 状态代码
  • Quickbase API 的详细错误消息
  • 建议的解决方案
  • 参数验证
  • JSON 数据验证
  • 正确处理 API 请求错误

常见错误场景

  • 缺少必需参数
  • JSON 数据格式无效
  • 不存在的表或字段 ID
  • WHERE 子句语法无效
  • 身份验证失败
  • 权限问题
  • 网络连接问题

所有错误响应都包含有用的诊断信息以协助排除故障。

贡献

  1. 分叉存储库
  2. 创建功能分支
  3. 提交你的更改
  4. 推送到分支
  5. 创建拉取请求

执照

MIT 许可证 - 详情请参阅许可证文件

-
security - not tested
F
license - not found
-
quality - not tested

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

  1. Overview
    1. Features
      1. For Users
      2. For Developers
    2. Prerequisites
      1. Installation
        1. Quick Start
          1. Available Tool Categories
            1. Connection Tools
            2. App Tools
            3. Table Tools
            4. Field Tools
            5. Record Tools
            6. File Tools
            7. Report Tools
          2. Not implemented
            1. For Developers & Contributors
              1. Starting the MCP Server Manually
              2. Running Tests
            2. Environment Variables
              1. Error Handling
                1. Common Error Scenarios
              2. Contributing
                1. License
                  ID: leb59ep0uk