Quickbase

🚀 Quickbase MCP Connector

The Quickbase MCP Connector is an unofficial quick - start guide for integrating AI assistants (such as Claude) with Quickbase's JSON RESTful API.

📋 Introduction

The Quickbase MCP Connector is an unofficial quick - start guide for integrating AI assistants (e.g., Claude) with Quickbase's JSON RESTful API. This project is not officially supported by Quickbase. Please use it with caution and assume all risks on your own.

⚠️ Disclaimer

This project is for personal or community development purposes only. There is no guarantee of stability or compatibility. Please carefully read the relevant documentation and terms before use.

🌟 Overview

The Quickbase MCP Connector aims to help users interact with Quickbase's data through the Model Context Protocol (MCP). The connector supports the following functions:

• Data Management: Including create, read, update, and delete operations.
• File Handling: Supports uploading and downloading files, as well as advanced management of attachments.
• Report Execution: Can run predefined Quickbase reports.

In addition, the connector also provides support for large data sets, ensuring efficient operation even in scenarios with large amounts of data.

✨ Features

User Features

• Data Management: Supports CRUD operations (create, read, update, and delete).
• File Handling: Provides functions for uploading and downloading files.
• Report Execution: Can run predefined Quickbase reports.

Developer Features

• API Coverage: Fully covers Quickbase's main API interfaces, including data operations, file management, and report execution.
• Error Handling: Provides detailed error classification and diagnostic information to help developers quickly locate problems.
• Parameter Validation: Ensures the legitimacy and validity of inputs.

📋 Prerequisites

Using the Quickbase MCP Connector requires the following environment:

• Python 3.6+ and Node.js 14+
• Valid Quickbase credentials must be provided, including:
  • QUICKBASE_REALM_HOST: The address of your Quickbase instance.
  • QUICKBASE_USER_TOKEN: The user token for authentication.
  • QUICKBASE_APP_ID: The unique identifier of the target application.

📦 Installation

Clone the Repository

git clone https://github.com/your-repository.git
cd your-repository

Run the Setup Script

python setup.py

Configure Environment Variables

Create an env_config file in the project root directory with the following content:

QUICKBASE_REALM_HOST=your-realm.quickbase.com
QUICKBASE_USER_TOKEN=your_user_token_here
QUICKBASE_APP_ID=your_app_id_here

🚀 Quick Start

Using Claude Desktop

1. Configure the MCP server:

   export MCP_SERVER_PORT=3535
   node src/quickbase/server.js
   

2. Run in the terminal:

   mcp-client -p 3535 --action list-apps
   

Using Claude Code

import {MCPClient} from 'quickbase-mcp';
const client = new MCPClient({
  realm: 'your-realm',
  token: 'your-token'
});
await client.listApps();

🛠️ Tool Categories

Connection Testing

• test-connection: Verify if the server is running properly.

Data Operations

• list-apps: Get all applications.
• get-app-details: Get detailed information about a specified application.
• query-data: Execute a data query.

File Operations

• upload-file: Upload a file to a specified record field.
• download-file: Download a file from a specified record field.

Report Execution

• run-report: Execute a predefined report and get the results.

⚠️ Unimplemented Features

The following features are not currently implemented:

• Deletion Operations: Including deleting applications, forms, fields, and records.
• User Management: Unable to retrieve or modify user information and permissions.
• Form Management: Does not support form - related operations.
• Dashboard Management: Unable to manage dashboards.
• Data Flow Management: Does not support pipeline operations.

🛠️ Developer Guide

Manually Start the Server

node src/quickbase/server.js

Run Tests

All tests are located in the tests/ directory:

python tests/run_tests.py

🐞 Error Handling

Common Errors

• Authentication Failure: Please check if the token is correct.
• Insufficient Permissions: Ensure that the user has sufficient permissions to access the target resource.

Detailed Logs

All operations are logged in detail for easy troubleshooting.

👏 Conclusion

The Quickbase MCP Connector provides you with a powerful toolset for interacting with Quickbase data. Whether you are a developer or a data administrator, you can efficiently manage and analyze data through this connector.