Integrate Dify with Live IBM Cloud Object Storage Data via CData Connect AI

Dify is an open source platform for building production-ready agentic workflows, chatbots, and other LLM applications. It includes built-in, two-way support for the model context protocol (MCP), allowing you to register remote MCP servers as tools in the platform to add external data sources and give your agents access to live data.

By integrating Dify with CData Connect AI through the built-in MCP Server, Dify gains governed, real-time access to live IBM Cloud Object Storage data. You can list catalogs, explore schemas, and query records from IBM Cloud Object Storage data using natural language prompts, with all data access running securely against authorized sources.

This article explains how to configure IBM Cloud Object Storage connectivity in Connect AI, generate the required personal access token, register the Connect AI MCP Server as a tool in Dify, add it to an agent application, and verify the integration by querying live IBM Cloud Object Storage data from Dify.

Step 1: Configure IBM Cloud Object Storage connectivity for Dify

Connectivity to IBM Cloud Object Storage from Dify is made possible through Connect AI's Remote MCP Server. To interact with IBM Cloud Object Storage data from Dify, start by creating and configuring a IBM Cloud Object Storage connection in Connect AI.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select IBM Cloud Object Storage from the Add Connection panel

3. Enter the necessary authentication properties to connect to IBM Cloud Object Storage.

   Register a New Instance of Cloud Object Storage

   If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

   1. Log in to your IBM Cloud account.
   2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

   Connecting using OAuth Authentication

   There are certain connection properties you need to set before you can connect. You can obtain these as follows:

   API Key

   To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

   1. Log in to your IBM Cloud account.
   2. Navigate to the Platform API Keys page.
   3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
   4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

   Cloud Object Storage CRN

   If you have multiple accounts, specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

   • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
   • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

   Connecting to Data

   You can now set the following to connect to data:

   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • ApiKey: Set this to your API key which was noted during setup.
   • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

   When you connect, the connector completes the OAuth process.

   1. Extracts the access token and authenticates requests.
   2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
   
4. Click Save & Test
5. Navigate to the Permissions tab and update user-based permissions

Add a Personal Access Token

A Personal Access Token (PAT) is used to authenticate the connection to Connect AI from Dify. It is best practice to create a separate PAT for each integration to maintain granular access control.

1. Click the gear icon () at the top right of the Connect AI app to open Settings
2. On the Settings page, go to the Access Tokens section and click Create PAT
3. Give the PAT a descriptive name and click Create

4. Copy the token when displayed and store it securely. It will not be shown again

With the IBM Cloud Object Storage connection configured and a PAT generated, Dify can now connect to IBM Cloud Object Storage data through Connect AI.

Step 2: Register the Connect AI MCP Server in Dify

Next, register the Connect AI Remote MCP Server as a tool in Dify so your agents and workflows can discover and call live data tools through Connect AI.

1. Log into Dify, or open your self-hosted Dify instance (version 1.6.0 or later, which includes built-in MCP support)
2. Navigate to the Integrations page, select Tools and click MCP tab

3. Click Add MCP Server (HTTP) and enter the following details:
   • Server URL: https://mcp.cloud.cdata.com/mcp
   • Name Icon: Give a descriptive name, for example, CData Connect AI
   • Server Identifier: A unique identifier, for example, cdata-connect-ai
   • Headers: Add an Authorization header with the value Basic your_base64_encoded_email_PAT

   Note: Dify will use Basic authentication with Connect AI. Combine your Connect AI user email and the PAT you created earlier in the format email:PAT, base64 encode the combined string, and prefix it with Basic.

4. Click Add & Authorize. Dify connects to the Connect AI MCP Server and lists the available tools

With the MCP server registered, the Connect AI tools are available to any agent application or workflow in your Dify workspace.

Step 3: Query live IBM Cloud Object Storage data from Dify

With the integration complete, build an agent application in Dify and interact with live IBM Cloud Object Storage data through natural language prompts.

1. From the Dify Studio page, click Create from Blank and select Agent as the application type
2. In the agent configuration, click Add under the Tools section and select the Connect AI MCP tools registered in Step 2
3. Select an LLM provider and model for the agent so it can interpret prompts and call MCP tools
4. In the preview panel, type a prompt in the chat input, for example:
   • Use the cdata-connect-ai tools to list all available catalogs
   • Show the available schemas and tables for IBM Cloud Object Storage
   • Query the top 5 records from a table in IBM Cloud Object Storage
5. The Dify agent calls the Connect AI MCP Server and returns live results from IBM Cloud Object Storage data

At this point, Dify communicates with the Connect AI MCP Server and retrieves live IBM Cloud Object Storage data through remote MCP tools directly from your agentic workflows.

Get started with CData Connect AI

To access hundreds of SaaS, big data, and NoSQL sources directly from your cloud applications, try CData Connect AI today. Download a free 14-day trial of CData Connect AI, and our Support Team is available to help with any questions you have.