接続の確立

The CData Code Assist MCP for SuiteCRM defines each connection to SuiteCRM 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/SuiteCRM Data Provider/".
On macOS, configuration files are stored in "~/Library/Application Support/CData/SuiteCRM 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.

SuiteCRM への接続

SuiteCRM に接続するための要件は、サイトが実行しているAPI のバージョンによって異なります。

SuiteCRM V4.1 API

V4.1 API でSuiteCRM データに接続するには、次の接続プロパティを設定します。

Schema： suitecrmv4。
URL：SuiteCRM アプリケーションに紐づいているURL。例：http://suite.crm.com
User：SuiteCRM アカウントに紐づいているユーザー。
Password：SuiteCRM アカウントのユーザーに紐付けられたパスワード。

SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュで説明しているように、メタデータをローカルに格納することをお勧めします。

SuiteCRM V8 API

SuiteCRM はOAuth2 認証標準を利用しています。SuiteCRM V8 API に接続する前に、OAuth2 の秘密鍵と公開鍵が適切に設定されていることを確認してください。詳しくは、SuiteCRM Developer Guide API V8 setup instructions を参照してください。

SuiteCRM V8 API への認証

SuiteCRM V8 API は認証メカニズムとしてOAuth2.0 を使用し、2つのグラント種別、PASSWORD またはCLIENT のいずれかに基づきます。

OAuth で認証するには、Schema をsuitecrmv8 に設定し、カスタムOAuth アプリケーションの作成で説明するとおり、カスタムOAuth アプリケーションの作成が必要となります。

クライアントクレデンシャルグラント

SuiteCRM V8 API に接続するには、次のプロパティを設定します。

Schema： suitecrmv8。
AuthScheme： OAuthClient。
OAuthClientId：カスタムOAuth アプリケーションの作成時に返されるクライアントキー。（カスタムOAuth アプリケーションの作成参照）
OAuthClientSecret：カスタムOAuth アプリケーションの作成時に返されるクライアントシークレット。（カスタムOAuth アプリケーションの作成参照）
InitiateOAuth： GETANDREFRESH。InitiateOAuth を使って、OAuth 交換や、手動でのOAuthAccessToken 接続プロパティの設定の繰り返しを避けられます。
URL：SuiteCRM システムのベースURL。例：https://suitecrmhost/

パスワードグラント

SuiteCRM V8 API に接続するには、次のプロパティを設定します。

Schema： suitecrmv8。
AuthScheme： OAuthPassword。
OAuthClientId：カスタムOAuth アプリケーションの作成時に返されるクライアントキー。（カスタムOAuth アプリケーションの作成参照）
OAuthClientSecret：カスタムOAuth アプリケーションの作成時に返されるクライアントシークレット。（カスタムOAuth アプリケーションの作成参照）
User：ユーザーのユーザーネーム。
Password：ユーザーのパスワード。
InitiateOAuth： GETANDREFRESH。InitiateOAuth を使って、OAuth 交換や、手動でのOAuthAccessToken 接続プロパティの設定の繰り返しを避けられます。
URL：SuiteCRM システムのベースURL。例：https://suitecrmhost/