Nocodb MCP Server

🚀 Nocodb MCP Server Documentation

This documentation provides a comprehensive guide to the Nocodb MCP server, including installation, configuration, feature overview, API reference, and security best practices.

🚀 Quick Start

Download and Installation

1. Clone the repository from GitHub:

   git clone https://github.com/nocodb/mcp-server.git
   cd mcp-server
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Configure environment variables:
   • Set the NOCODB_BASE_ID environment variable, for example:

     export NOCODB_BASE_ID=your_base_id
     

Start the Server

python nocodb_mcp_server.py

✨ Features

Tool Functions

• Data Operations: Supports basic CRUD operations.
• Table Structure Management: Provides the ability to retrieve table structure information.
• Bulk Operations: Supports single and bulk data processing.

Usage Examples

Basic Usage

# Example of querying records
print(json.dumps(find_records("customers", {"limit": 10})))

# Example of inserting a new record
new_record = {"name": "张三", "email": "zhangsan@example.com"}
print(json.dumps(create_records("customers", [new_record])))

📚 Documentation

Base URL

• All requests are directed to https://api.nocodb.com/api/v2/.

Request Header Settings

GET /tables/customers/records HTTP/1.1
Host: api.nocodb.com
xc-token: your_api_token

🔧 Technical Details

Authentication Mechanism

• Use the xc-token request header for authentication.
• Ensure the security of the API token and avoid leakage.

Permission Management

• Control data access through Nocodb's permission system.
• Regularly review and update API token permissions.

Error Handling

Common Error Codes

Error Response Example

{
  "error": {
    "code": 401,
    "message": "Authentication failed"
  }
}

Advanced Features

Logging

• The default log level is ERROR.
• You can adjust logging.basicConfig to set detailed log output.

Bulk Operation Optimization

• Use the bulk_ids parameter for efficient bulk processing.
• Ensure network stability to avoid data transfer interruptions.

Security Best Practices

1. Principle of Least Privilege: Create API tokens with the minimum necessary permissions.
2. Environment Variable Management: Avoid hard - coding sensitive information in the code and always use environment variables.
3. Audit Logs: Enable Nocodb's audit function to monitor data operations.
4. Regular Review: Periodically check and update API tokens and their permissions.

By following these guidelines, you can ensure the security and efficient operation of the Nocodb MCP server.