Quickbase MCP Server

🚀 QuickBase MCP Server

A Model Context Protocol (MCP) server offering maximum flexibility for QuickBase operations. It enables you to create tables, add fields, modify relationships, and perform all QuickBase operations via MCP tools.

🚀 Quick Start

This QuickBase MCP Server allows you to perform a variety of QuickBase operations with great flexibility. You can manage applications, tables, fields, records, relationships, and more.

✨ Features

Application Management

• Retrieve application information
• List all available tables
• Test the connection to QuickBase

Table Operations

• Create new tables as needed
• Obtain detailed information about existing tables
• Update table properties according to your requirements
• Remove unnecessary tables

Field Management

• Fetch all fields associated with a specific table
• Create new fields of all supported types
• Modify existing fields
• Delete fields that are no longer required
• Support lookups, formulas, and relationships

Record Operations

• Query records with filtering and sorting options
• Access specific records
• Create single or multiple records at once
• Update existing records
• Delete records
• Search for records by text
• Perform bulk operations on records

Relationship Management

• Establish parent - child relationships between tables
• Retrieve existing relationships
• Manage foreign keys

Utility Functions

• Get and execute reports
• Benefit from advanced querying capabilities
• Rely on robust error handling and retry logic

📦 Installation

1. Clone and set up the server:

cd quickbase-mcp-server
npm install

2. Copy the environment configuration:

cp env.example .env

3. Configure your QuickBase credentials in the .env file:

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

# Optional: Default settings
QB_DEFAULT_TIMEOUT=30000
QB_MAX_RETRIES=3

# MCP Server Configuration
MCP_SERVER_NAME=quickbase-mcp
MCP_SERVER_VERSION=1.0.0

4. Build the project:

npm run build

💻 Usage Examples

Run the server standalone:

npm start

Add to your MCP client configuration:

Add the following to your MCP client configuration (e.g., 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"
      }
    }
  }
}

Basic Usage

Create a new table:

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

Add a field to a table:

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

Query records with filtering:

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

Create a new record:

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

📚 Documentation

Available Tools

Application Tools

• quickbase_get_app_info - Retrieve application information
• quickbase_get_tables - List all tables
• quickbase_test_connection - Test the connection

Table Tools

• quickbase_create_table - Create a new table
• quickbase_get_table_info - Get table details
• quickbase_delete_table - Delete a table

Field Tools

• quickbase_get_table_fields - Get all fields
• quickbase_create_field - Create a new field
• quickbase_update_field - Update an existing field
• quickbase_delete_field - Delete a field

Record Tools

• quickbase_query_records - Query with filters and sorting
• quickbase_get_record - Get a specific record
• quickbase_create_record - Create a new record
• quickbase_update_record - Update an existing record
• quickbase_delete_record - Delete a record
• quickbase_bulk_create_records - Create multiple records
• quickbase_search_records - Search by text

Relationship Tools

• quickbase_create_relationship - Create a table relationship
• quickbase_get_relationships - Get existing relationships

Utility Tools

• quickbase_get_reports - Get all reports
• quickbase_run_report - Run a specific report

Field Types Supported

• text - Single line text
• text_choice - Single choice dropdown
• text_multiline - Multi - line text
• richtext - Rich text editor
• numeric - Number field
• currency - Currency field
• percent - Percentage field
• date - Date field
• datetime - Date/time field
• checkbox - Checkbox field
• email - Email field
• phone - Phone number field
• url - URL field
• address - Address field
• file - File attachment
• lookup - Lookup from another table
• formula - Calculated field
• reference - Table reference

Development

Run in development mode:

npm run dev

Run tests:

npm test

Troubleshooting

Common Issues

1. Authentication Error

   • Ensure your user token is correct.
   • Verify that the token permissions cover your app.
   • Make sure the realm hostname is accurate.

2. Table/Field Not Found

   • Double - check that the table/field IDs are correct.
   • Confirm that you have the necessary permissions to access them.

3. Field Creation Fails

   • Check that the field type is supported.
   • Verify that choices are provided for choice fields.
   • Ensure the formula syntax is correct for formula fields.

Enable Debug Logging

Set the following environment variable:

DEBUG=quickbase-mcp:*

Implementation Notes

This server offers maximum flexibility for QuickBase operations through the following features:

1. Direct API Access - It directly utilizes the QuickBase REST API v1.
2. Complete Field Support - All QuickBase field types are supported.
3. Relationship Management - It can create and manage table relationships.
4. Bulk Operations - Efficient bulk record operations are available.
5. Advanced Querying - Full support for QuickBase query syntax.
6. Error Handling - Comprehensive error handling and retry logic are implemented.

📄 License

This project is released under the MIT License.