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 憑證。