Quickbase MCP Server

🚀 QuickBase MCP Server

QuickBase MCP Server 是一個模型上下文協議（MCP）服務器，為 QuickBase 操作提供了極大的靈活性。該服務器允許你通過 MCP 工具創建表、添加字段、修改關係，並執行所有 QuickBase 操作。

🚀 快速開始

獲取 QuickBase 用戶令牌

1. 訪問 QuickBase → 我的應用 → 用戶賬戶。
2. 點擊“管理用戶令牌”。
3. 點擊“新建用戶令牌”。
4. 為其命名，例如“MCP Server”。
5. 設置適當的權限。
6. 將令牌複製到你的 .env 文件中。

安裝

1. 克隆並設置服務器：

cd quickbase-mcp-server
npm install

2. 複製環境配置：

cp env.example .env

3. 在 .env 文件中配置你的 QuickBase 憑證：

# QuickBase 配置
QB_REALM=yourname.quickbase.com
QB_USER_TOKEN=your_quickbase_user_token_here
QB_APP_ID=yourid

# 可選：默認設置
QB_DEFAULT_TIMEOUT=30000
QB_MAX_RETRIES=3

# MCP 服務器配置
MCP_SERVER_NAME=quickbase-mcp
MCP_SERVER_VERSION=1.0.0

4. 構建項目：

npm run build

使用

獨立運行服務器：

npm start

添加到你的 MCP 客戶端配置：

添加到你的 MCP 客戶端配置（例如，Claude Desktop）：

{
  "mcpServers": {
    "quickbase": {
      "command": "node",
      "args": ["/path/to/quickbase-mcp-server/dist/index.js"],
      "env": {
        "QB_REALM": "yourname.quickbase.com",
        "QB_USER_TOKEN": "your_token_here",
        "QB_APP_ID": "yourid"
      }
    }
  }
}

✨ 主要特性

應用管理

• 獲取應用信息
• 列出所有表
• 測試連接

表操作

• 創建新表
• 獲取表信息
• 更新表屬性
• 刪除表

字段管理

• 獲取表的所有字段
• 創建新字段（支持所有類型）
• 更新現有字段
• 刪除字段
• 支持查找、公式、關係

記錄操作

• 帶過濾和排序的查詢記錄
• 獲取特定記錄
• 創建單條或多條記錄
• 更新現有記錄
• 刪除記錄
• 按文本搜索記錄
• 批量操作

關係管理

• 創建父子關係
• 獲取現有關係
• 外鍵管理

實用功能

• 獲取並運行報告
• 高級查詢功能
• 錯誤處理和重試邏輯

📦 安裝指南

克隆並設置服務器

cd quickbase-mcp-server
npm install

複製環境配置

cp env.example .env

配置 QuickBase 憑證

在 .env 文件中配置你的 QuickBase 憑證：

# QuickBase 配置
QB_REALM=yourname.quickbase.com
QB_USER_TOKEN=your_quickbase_user_token_here
QB_APP_ID=yourid

# 可選：默認設置
QB_DEFAULT_TIMEOUT=30000
QB_MAX_RETRIES=3

# MCP 服務器配置
MCP_SERVER_NAME=quickbase-mcp
MCP_SERVER_VERSION=1.0.0

構建項目

npm run build

💻 使用示例

基礎用法

創建新表

{
  "name": "quickbase_create_table",
  "arguments": {
    "name": "New Projects",
    "description": "Project tracking table"
  }
}

向表中添加字段

{
  "name": "quickbase_create_field",
  "arguments": {
    "tableId": "bu65pc8px",
    "label": "Project Status",
    "fieldType": "text_choice",
    "choices": ["Planning", "Active", "Complete", "On Hold"],
    "required": true
  }
}

帶過濾的查詢記錄

{
  "name": "quickbase_query_records",
  "arguments": {
    "tableId": "bu65pc8px",
    "where": "{6.EX.'John'}",
    "top": 10,
    "sortBy": [{"fieldId": 3, "order": "DESC"}]
  }
}

創建新記錄

{
  "name": "quickbase_create_record",
  "arguments": {
    "tableId": "bu65pc8px",
    "fields": {
      "6": {"value": "John Doe"},
      "7": {"value": "123 Main St"},
      "8": {"value": "john@example.com"}
    }
  }
}

高級用法

目前暫無高級用法示例。

📚 詳細文檔

可用工具

應用工具

• quickbase_get_app_info - 獲取應用信息
• quickbase_get_tables - 列出所有表
• quickbase_test_connection - 測試連接

表工具

• quickbase_create_table - 創建新表
• quickbase_get_table_info - 獲取表詳情
• quickbase_delete_table - 刪除表

字段工具

• quickbase_get_table_fields - 獲取所有字段
• quickbase_create_field - 創建新字段
• quickbase_update_field - 更新現有字段
• quickbase_delete_field - 刪除字段

記錄工具

• quickbase_query_records - 帶過濾/排序的查詢
• quickbase_get_record - 獲取特定記錄
• quickbase_create_record - 創建新記錄
• quickbase_update_record - 更新現有記錄
• quickbase_delete_record - 刪除記錄
• quickbase_bulk_create_records - 創建多條記錄
• quickbase_search_records - 按文本搜索

關係工具

• quickbase_create_relationship - 創建表關係
• quickbase_get_relationships - 獲取現有關係

實用工具

• quickbase_get_reports - 獲取所有報告
• quickbase_run_report - 運行特定報告

支持的字段類型

• text - 單行文本
• text_choice - 單選下拉框
• text_multiline - 多行文本
• richtext - 富文本編輯器
• numeric - 數字字段
• currency - 貨幣字段
• percent - 百分比字段
• date - 日期字段
• datetime - 日期/時間字段
• checkbox - 複選框字段
• email - 電子郵件字段
• phone - 電話號碼字段
• url - URL 字段
• address - 地址字段
• file - 文件附件
• lookup - 從另一個表查找
• formula - 計算字段
• reference - 表引用

開發

以開發模式運行

npm run dev

運行測試

npm test

故障排除

常見問題

1. 身份驗證錯誤
   • 檢查你的用戶令牌是否正確。
   • 驗證令牌權限是否包含你的應用。
   • 確保領域主機名正確。
2. 未找到表/字段
   • 驗證表/字段 ID 是否正確。
   • 檢查你是否有訪問權限。
3. 字段創建失敗
   • 檢查字段類型是否受支持。
   • 驗證選擇字段是否提供了選項。
   • 確保公式字段的公式語法正確。

啟用調試日誌

設置環境變量：

DEBUG=quickbase-mcp:*

🔧 技術細節

本服務器通過以下方式為 QuickBase 操作提供了極大的靈活性：

1. 直接 API 訪問 - 直接使用 QuickBase REST API v1。
2. 完整的字段支持 - 支持所有 QuickBase 字段類型。
3. 關係管理 - 可以創建和管理表關係。
4. 批量操作 - 高效的批量記錄操作。
5. 高級查詢 - 支持完整的 QuickBase 查詢語法。
6. 錯誤處理 - 全面的錯誤處理和重試邏輯。

📄 許可證

本項目採用 MIT 許可證。