MCP Quickbase

🚀 Quickbase MCP Connector Project Documentation

The Quickbase MCP Connector is a tool for interacting with the Quickbase platform. It supports integration with AI assistants (such as Claude) via the Model Context Protocol (MCP). This connector offers a range of functions, including data management, file operations, and report execution.

🚫 Disclaimer

This project is not an official Quickbase product or service and has not received any official support. Quickbase is a registered trademark, and its copyright belongs to the relevant company.

🌐 Overview

The Quickbase MCP Connector aims to help users manage Quickbase data through an AI assistant. It supports CRUD operations (Create, Read, Update, Delete) and provides functions for file operations and report execution.

✨ Features

User Features

• Data Management: Allows users to create, read, update, and delete data.
• File Operations: Supports uploading, downloading, and managing attachments.
• Report Execution: Can run Quickbase reports.

Developer Features

• Scalability: Developers can easily add custom function modules.
• Error Handling: Provides detailed error information and suggestions for solutions.

📦 Installation Requirements

• Operating System: Supports Linux, macOS, and Windows.
• Dependencies:
  • Python 3.8 or higher.
  • Node.js 14 or higher.
• Credentials: Requires a Quickbase user token and an app ID.

📦 Installation Guide

Step 1: Clone the Repository

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

Step 2: Set Environment Variables

Create a .env file in the project root directory:

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

Step 3: Install Dependencies

Install Python and Node.js dependencies:

pip install -r requirements.txt
npm install

🚀 Quick Start

Configure Quickbase Desktop

1. Open the terminal and run the following command to start the MCP server:

   node src/quickbase/server.js
   

2. Access http://localhost:3535 in your browser.

Use Claude Code

1. Set environment variables:

   export QUICKBASE_TABLE_ID=your_table_id_here
   export QUICKBASE_RECORD_ID=your_record_id_here
   export QUICKBASE_FILE_FIELD_ID=your_file_field_id_here
   

2. Start the server and connect to Quickbase.

💻 Usage Examples

Basic Usage

The following shows how to perform basic operations using the Quickbase MCP Connector:

# Here could be some basic code examples if provided in the original
# For now, assume we have a simple data creation example
import requests

# Assume we have set up the environment variables correctly
import os
realm_host = os.getenv('QUICKBASE_REALM_HOST')
user_token = os.getenv('QUICKBASE_USER_TOKEN')
app_id = os.getenv('QUICKBASE_APP_ID')

headers = {
    'QB-Realm-Hostname': realm_host,
    'Authorization': f'QB-USER-TOKEN {user_token}'
}

data = {
    # Some sample data to create
    'field_1': 'value_1',
    'field_2': 'value_2'
}

url = f'https://{realm_host}/db/{app_id}?a=API_AddRecord'
response = requests.post(url, headers=headers, json=data)
print(response.json())

Advanced Usage

# For advanced usage, assume we want to run a complex report
import requests

# Set up headers and environment variables as before
import os
realm_host = os.getenv('QUICKBASE_REALM_HOST')
user_token = os.getenv('QUICKBASE_USER_TOKEN')
app_id = os.getenv('QUICKBASE_APP_ID')
report_id = 'your_report_id'  # Assume we have a report ID

headers = {
    'QB-Realm-Hostname': realm_host,
    'Authorization': f'QB-USER-TOKEN {user_token}'
}

url = f'https://{realm_host}/db/{app_id}?a=API_RunReport&rid={report_id}'
response = requests.get(url, headers=headers)
print(response.json())

📚 Documentation

Functional Modules

Data Management Tools

• Create Data: Send a POST request via the API.
• Query Data: Support GET requests to retrieve data.
• Update Data: Use PATCH or PUT methods to update data.
• Delete Data: Support DELETE requests.

File Operations

• Upload File: Attach a file to a specified field.
• Download File: Download an attachment via URL.
• Manage Attachments: Add, delete, or replace attachments.

Report Execution

• Run Report: Trigger a Quickbase report and get the results.
• Process Output: Parse the report output for subsequent operations.

Environment Variables

Error Handling

Error Types

• Input Error: Incorrect parameter format.
• Authorization Error: Invalid token or insufficient permissions.
• Network Error: Unable to connect to the Quickbase service.

Handling Methods

• Check the log file for detailed error information.
• Ensure that credentials and environment variables are set correctly.
• Check the internet connection in case of network issues.

Contribution Guidelines

We welcome the community to participate in the project development! Here are the contribution steps:

1. Fork the Repository: Fork the project on GitHub.
2. Create a Branch: Create a new branch for new features or bug fixes.
3. Submit Changes: Submit code changes and add detailed descriptions.
4. Generate a Pull Request: Push your branch to the original repository to create a PR.

📄 License

This project is licensed under the MIT License, as follows:

MIT License

For further information, please visit our GitHub repository or contact the maintenance team.