The CData Code Assist MCP for Cloudant defines each connection to Cloudant as a named configuration that an MCP Client (such as Claude Desktop) can use when sending natural language queries.

You create and manage these configurations using the CData Code Assist MCP Configuration Tool. The tool automatically handles formatting, storage, and registration with MCP clients.

Understanding Connection Configurations

Each connection configuration is stored in a .mcp file. This file includes the details needed to initialize the connector when an MCP Client starts a session.

• On Windows, configuration files are stored in "~/AppData/Roaming/CData/Cloudant Data Provider/".
• On macOS, configuration files are stored in "~/Library/Application Support/CData/Cloudant Data Provider/".

The .mcp file is a text file that contains a list of connection properties and a timestamp. For example:

#Tue May 20 15:48:40 EDT 2025
AuthScheme=Basic
User=myUser
Password=myPassword
Security Token=myToken

The configuration tool handles these settings automatically. Each saved configuration enables an MCP client to launch a dedicated MCP server instance with the correct connector and options. Manual file editing is not required.

Cloudant への認証

Cloudant は2種類の認証をサポートします。

• OAuthAPIKey：API Key に基づいた認証を行います。AuthScheme をOAuthAPIKey に設定し、Cloudant インスタンスのAPIKey とURL の値を指定します。
• Basic：基本的なユーザー名 / パスワード認証。AuthScheme をBasic に設定します。

IBM Cloud IAM

IBM Cloud IAM is OAuthAPIKey-based authentication accessed via a web browser.

To authenticate to IBM Cloud, set AuthScheme to OAuthAPIKey and supply the ApiKey and the URL of the target Cloudant instance (for example, https://0c9d3837-8304-4aab-a65a-648169970943-bluemix.cloudant.com).

After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

When you connect, the 本製品 completes the OAuthAPIKey process.

1. Extracts the access token and authenticates requests.
2. Saves OAuthAPIKey values in OAuthSettingsLocation to be persisted across connections.

Retrieving OAuthAPIKey connection properties

To retrieve the OAuthAPIKey connection properties:

1. Create an account in IBM Cloud.
2. Obtain the ApiKey:
   1. Log in to your IBM Cloud account.
   2. Navigate to Platform API Keys page.
   3. To create a new API Key, click Create an IBM Cloud API Key. Cloudant displays a pop-up form.
   4. Specify the API Key name and click Create. Cloudant displays the ApiKey you just created.
      Save this information for future reference.

Registering a new instance of Cloudant

If you do not already have Cloud Object Storage in your IBM Cloud account, you can install an instance of SQL Query in your account:

1. Log in to your IBM Cloud account.
2. Navigate to the Cloudant page.
3. Choose a name for your instance and click Create. You are redirected to that Cloudant instance.

IBM Cloudant Legacy

IBM Cloudant Legacy 経由で接続するには、有効なIBM Cloudant サービスクレデンシャルを持っていることを確認してください。

IBM Cloudant のサービスクレデンシャルを作成するには：

1. IBM Cloud ダッシュボードにログインします。
2. Menu icon -> Resource List に移動し、IBM Cloudant サービスインスタンスを開きます。
3. メニューで、Service credentials をクリックします。
4. New credential をクリックします。Cloudant はAdd new credential ウィンドウを表示します。
5. 新しい資格情報の名前を入力します。
6. Add をクリックします。 資格情報がService credentials テーブルに追加されます。
7. Actions -> View credentials をクリックします。
8. JSON ファイルからUser およびPassword の値を取得します。

取得した値を使用して、User およびPassword を設定します。

ローカルインスタンスへの認証

Cloudant は、バージョン1.1.0以上のローカルインスタンスのデータへの認証をサポートします。

ローカルインスタンスへの認証を行うには、次のパラメータを設定します。

1. URL：ローカルインスタンスのURL。例： http://localhost:8006
2. User：ユーザーネーム。
3. Password：パスワード。