🚀 Quickbase MCP 連接器
這是一個用於與 Quickbase JSON RESTful API 集成的 模型上下文協議 (MCP) 連接器。
免責聲明:這是一個非官方的獨立項目,與 Quickbase, Inc. 沒有任何關聯、贊助或背書。此連接器“按原樣”提供,不提供任何形式的保證,並且 Quickbase 不提供支持。用戶在使用此連接器時,有責任自行遵守所有適用的法律、法規和安全要求。
🚀 快速開始
對於那些只想使用 Claude 或 Claude Code 來嘗試此連接器的用戶:
- 安裝依賴項並設置服務器:
./setup.sh
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 配合使用:
claude mcp add quickbase node src/quickbase/server.js
現在你可以在 Claude 會話中使用 Quickbase 工具了!示例提示:
"使用 quickbase 連接器列出我的 Quickbase 應用中的所有表。"
✨ 主要特性
面向用戶
- AI 驅動的 Quickbase 訪問:通過 Claude 直接與你的 Quickbase 數據進行交互。
- 數據管理:通過自然語言創建、查看和更新你的應用、表和記錄。
- 文件處理:上傳和下載記錄的文件附件。
- 報告訪問:運行你的 Quickbase 報告,並直接在聊天中獲取結果。
- 大數據集支持:在查詢大量記錄時自動處理分頁。
面向開發者
- 全面的 API 覆蓋:訪問 Quickbase API 的核心功能。
- 結構化響應:一致的響應格式,便於可靠解析。
- 批量操作:高效處理批量記錄操作。
- 錯誤診斷:帶有狀態碼和故障排除信息的詳細錯誤消息。
📦 安裝指南
- 克隆倉庫:
git clone https://github.com/danielbushman/Quickbase-MCP-connector.git
cd Quickbase-MCP-connector
- 設置環境:
./setup.sh
- 配置你的 Quickbase 憑證:
cp .env.example .env
📚 詳細文檔
可用工具類別
連接工具
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)
- 快速字段表單操作(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
錯誤處理
該連接器提供了全面的錯誤處理,包括:
- 錯誤類型分類
- HTTP 狀態碼
- Quickbase API 的詳細錯誤消息
- 建議的解決方案
- 參數驗證
- JSON 數據驗證
- 正確處理 API 請求錯誤
常見錯誤場景
- 缺少必需參數
- 無效的 JSON 數據格式
- 不存在的表或字段 ID
- 無效的 WHERE 子句語法
- 身份驗證失敗
- 權限問題
- 網絡連接問題
所有錯誤響應都包含有用的診斷信息,以幫助進行故障排除。
貢獻
- 分叉倉庫
- 創建功能分支
- 提交你的更改
- 推送到分支
- 創建拉取請求
📄 許可證
本項目採用 MIT 許可證,詳情請參閱 LICENSE 文件。