CData Sync

You can run the CData Sync MCP Server to expose REST API controls as MCP tools, enabling AI assistants to manage data synchronization jobs, connections, and ETL tasks. It supports both local (stdio) usage and remote (HTTP) deployments, giving you flexible options for development and production workloads.

How to use

Use the MCP Server to manage CData Sync entities through either a local stdio setup for desktop use or a remote HTTP setup for web-based integrations. You can list, read, create, update, and delete connections, jobs, tasks, transformations, users, and more. Real-time updates via streaming let you monitor job progress and tool activity as it happens.

For development and testing, you can run both transports simultaneously to compare behaviors in desktop and remote environments. In production, prefer a dedicated HTTP deployment or a combined approach based on your infrastructure needs.

How to install

Prerequisites: Node.js 18+ and a running CData Sync instance. Decide whether you will run the MCP Server locally with stdio or deploy it remotely with HTTP. Ensure you have a workspace UUID if you want to scope operations.

Step 1: Install dependencies after obtaining the MCP server package.

Step 2: Build the project to produce the runtime artifacts.

Step 3: Configure environment variables to connect to your CData Sync instance and set the transport mode. You will typically provide the base URL, an auth token, and an optional workspace.

Step 4: Start the desired transport mode: stdio for local desktop usage, HTTP for remote deployments, or both for development testing.

Configuration and deployment notes

The server supports these environment variables to configure connectivity and behavior. Typical values are provided as examples and should be replaced with your actual credentials and endpoints.

When using stdio, you define a command that runs the runtime index and pass necessary environment variables to shape the runtime behavior.

When using HTTP, you run a server that exposes the MCP endpoints and handles streaming updates through Server-Sent Events.

Deployment and runtime quick references

{
  "mcpServers": {
    "cdata-sync-server": {
      "command": "node",
      "args": ["/absolute/path/to/cdata-sync-mcp-server/dist/index.js"],
      "env": {
        "MCP_TRANSPORT_MODE": "stdio",
        "CDATA_AUTH_TOKEN": "your-token-here",
        "CDATA_BASE_URL": "http://localhost:8181/api.rsc",
        "CDATA_WORKSPACE": "your-workspace-uuid-here",
        "DISABLE_SSE": "true"
      }
    }
  }
}

Available tools

read_connections

List, count, get details, or test connections

write_connections

Create, update, or delete connections

get_connection_tables

List tables in a connection

get_table_columns

Get table schema information

read_jobs

List, count, get details, status, history, or logs

write_jobs

Create, update, or delete jobs

execute_job

Run a sync job immediately

cancel_job

Stop a running job

execute_query

Run custom SQL queries

read_tasks

List, count, or get task details

write_tasks

Create, update, or delete tasks

read_transformations

List, count, or get transformation details

write_transformations

Create, update, or delete transformations

read_users

List, count, or get user details

write_users

Create or update users

read_requests

List, count, or get request log details

write_requests

Delete request logs

read_history

List or count execution history records

read_certificates

List certificates

write_certificates

Create certificates

configure_sync_server

Get or update server configuration