MCPサーバー

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

このリソースを使用して、MCP(Model Context Protocol)サーバーをプログラムから管理します。

クイックリファレンス

タイプリソース説明
GET/api/mcp/mcp_serversMCPサーバーを一覧表示します。
POST/api/mcp/mcp_serversMCPサーバーを作成します。
GET/api/mcp/mcp_servers/:handleMCPサーバーの詳細を取得します。
PUT/api/mcp/mcp_servers/:handleMCPサーバーを更新します。
DELETE/api/mcp/mcp_servers/:handleMCPサーバーを削除します。
POST/api/mcp/mcp_servers/:handle/token_renewMCPサーバーの認証トークンを更新します。
POST/api/mcp/mcp_servers/:handle/assign_toolsMCPサーバーにツールを割り当てます。
POST/api/mcp/mcp_servers/:handle/assign_user_groupsMCPサーバーにユーザーグループを割り当てます。
POST/api/mcp/mcp_servers/:handle/remove_user_groupsMCPサーバーからユーザーグループを削除します。
PUT/api/mcp/mcp_servers/:handle/update_folderMCPサーバーを別のフォルダに移動します。
GET/api/mcp/mcp_servers/:mcp_server_handle/server_policiesサーバーポリシー設定を取得します。
PUT/api/mcp/mcp_servers/:mcp_server_handle/server_policiesサーバーポリシー設定を更新します。
GET/api/mcp/mcp_servers/:mcp_server_handle/toolsMCPサーバーのツールを一覧表示します。
PUT/api/mcp/mcp_servers/:mcp_server_handle/tools/:idMCPのツール説明を更新します。
DELETE/api/mcp/mcp_servers/:mcp_server_handle/tools/:idツールを削除します。
GET/api/mcp/user_groupsIDプロバイダーのユーザーグループを一覧表示します。

MCPサーバーの一覧表示

ワークスペース内のMCPサーバーのリストを返します。

shell
GET /api/mcp/mcp_servers

クエリパラメーター

名前タイプ説明
project_idnumber
optional
プロジェクトIDでフィルタリングします。
folder_idnumber
optional
フォルダIDでフィルタリングします。
authentication_methodstring
任意
認証方法でフィルタリングします。 受け入れられる値: tokenworkato_idp
pagenumber
optional
ページ番号。 デフォルトは1です。
per_pagenumber
optional
ページごとの項目数。 最大値は50です。

サンプルリクエスト

shell
curl  -X GET 'https://www.workato.com/api/mcp/mcp_servers?folder_id=27180380' \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json
{
    "data": [
        {
            "id": 1001,
            "name": "Sales Tools MCP Server",
            "description": "Provides CRM and deal management tools for AI clients",
            "folder_id": 27180380,
            "project_id": 13595198,
            "authentication_method": "token",
            "tools_count": 5
        },
        {
            "id": 1002,
            "name": "HR Automation Server",
            "description": "HR onboarding and employee management tools",
            "folder_id": 27180380,
            "project_id": 13595198,
            "authentication_method": "workato_idp",
            "tools_count": 3
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 50
}

MCPサーバーを作成する

ワークスペース内に新しいMCPサーバーを作成します。

shell
POST /api/mcp/mcp_servers

ペイロード

名前タイプ説明
namestring
必須
サーバー名。
folder_idnumber
必須
MCPサーバーのフォルダID。
説明string
任意
サーバーの説明。
asset_idnumber
optional
APIコレクションID。 プロジェクトアセットサーバーを作成する場合は省略します。
toolsarray of objects
optional
作成時にサーバーに割り当てるツール。 各オブジェクトにはtrigger_application(string)とid(string)が必要です。 workato_recipe_functionおよびworkato_api_platformツールで使用する場合、idは数値です。 workato_genieツールで使用する場合、idは文字列ハンドルです。

リクエスト例

shell
curl  -X POST https://www.workato.com/api/mcp/mcp_servers \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Sales Tools MCP Server",
            "description": "Provides CRM and deal management tools for AI clients",
            "folder_id": 27180380,
            "tools": [
              {
                "trigger_application": "workato_api_platform",
                "id": "98231"
              }
            ]
          }'

レスポンス例

json
{
    "data": {
        "id": 1001,
        "name": "Sales Tools MCP Server",
        "description": "Provides CRM and deal management tools for AI clients",
        "asset_type": "api_collection",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 1,
        "mcp_url": "https://www.workato.com/mcp/servers/sales-tools-mcp-server?token=abc123xyz",
        "auth_type": "token",
        "idp_user_group_ids": [],
        "api_collection": null,
        "created_at": "2025-10-15T13:41:05.207-07:00",
        "updated_at": "2025-10-15T13:41:05.207-07:00"
    }
}

MCPサーバー詳細の取得

特定のMCPサーバーの詳細を取得します。

shell
GET /api/mcp/mcp_servers/:handle

URLパラメーター

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

リクエスト例

shell
curl  -X GET 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例

json
{
    "data": {
        "id": 1001,
        "name": "Sales Tools MCP Server",
        "description": "Provides CRM and deal management tools for AI clients",
        "asset_type": "api_collection",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 5,
        "mcp_url": "https://www.workato.com/mcp/servers/sales-tools-mcp-server?token=abc123xyz",
        "auth_type": "token",
        "idp_user_group_ids": [],
        "api_collection": null,
        "created_at": "2025-10-15T13:41:05.207-07:00",
        "updated_at": "2025-10-16T09:22:11.100-07:00"
    }
}

MCPサーバーの更新

既存のMCPサーバーを更新します。

shell
PUT /api/mcp/mcp_servers/:handle

URLパラメータ

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

ペイロード

名前タイプ説明
namestring
任意
サーバー名。
説明string
任意
サーバーの説明。
auth_typestring
任意
認証タイプ。 受け入れられる値: tokenworkato_idp
idp_user_group_idsarray of strings
optional
サーバーにアクセスできるIDプロバイダーユーザーグループID。 auth_typeworkato_idpの場合にのみ適用されます。
folder_idnumber
optional
サーバーの移動先フォルダID。

リクエスト例

shell
curl  -X PUT 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Sales & CRM Tools MCP Server",
            "description": "Provides CRM, deal management, and pipeline tools for AI clients",
            "auth_type": "token"
          }'

レスポンス例

json
{
    "data": {
        "id": 1001,
        "name": "Sales & CRM Tools MCP Server",
        "description": "Provides CRM, deal management, and pipeline tools for AI clients",
        "asset_type": "api_collection",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 5,
        "mcp_url": "https://www.workato.com/mcp/servers/sales-tools-mcp-server?token=abc123xyz",
        "auth_type": "token",
        "idp_user_group_ids": [],
        "api_collection": null,
        "created_at": "2025-10-15T13:41:05.207-07:00",
        "updated_at": "2025-10-17T11:05:33.812-07:00"
    }
}

MCPサーバーの削除

MCPサーバーを削除します。

shell
DELETE /api/mcp/mcp_servers/:handle

URLパラメータ

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

リクエスト例

shell
curl  -X DELETE 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例

成功時に204 No Contentを返します。

MCPサーバー認証トークンの更新

MCPサーバーの新しい認証トークンを生成し、以前のトークンを無効にします。 セキュリティイベント後、または定期的な認証情報ローテーションポリシーの一環として、認証情報をローテーションするためにこのエンドポイントを使用します。

shell
POST /api/mcp/mcp_servers/:handle/token_renew

URLパラメータ

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

リクエスト例

shell
curl  -X POST 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server/token_renew' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例

更新されたトークンを含む新しいmcp_urlを持つ、更新済みのMCPサーバーオブジェクトを返します。

json
{
    "data": {
        "id": 1001,
        "name": "Sales & CRM Tools MCP Server",
        "description": "Provides CRM, deal management, and pipeline tools for AI clients",
        "asset_type": "api_collection",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 5,
        "mcp_url": "https://www.workato.com/mcp/servers/sales-tools-mcp-server?token=newtoken789",
        "auth_type": "token",
        "idp_user_group_ids": [],
        "api_collection": null,
        "created_at": "2025-10-15T13:41:05.207-07:00",
        "updated_at": "2025-10-18T08:00:00.000-07:00"
    }
}

MCPサーバーへのツールの割り当て

1つ以上のツールをMCPサーバーに割り当てます。 サーバーにすでに割り当てられているツールは重複されません。

shell
POST /api/mcp/mcp_servers/:handle/assign_tools

URLパラメータ

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

ペイロード

名前タイプ説明
toolsオブジェクトの配列
必須
割り当てるツール。 各オブジェクトにはtrigger_application(string)とid(string)が必要です。

リクエスト例

shell
curl  -X POST 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server/assign_tools' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "tools": [
              {
                "trigger_application": "workato_api_platform",
                "id": "98232"
              },
              {
                "trigger_application": "workato_genie",
                "id": "my-genie-handle"
              }
            ]
          }'

レスポンス例

更新済みのMCPサーバーオブジェクトを返します。

json
{
    "data": {
        "id": 1001,
        "name": "Sales & CRM Tools MCP Server",
        "description": "Provides CRM, deal management, and pipeline tools for AI clients",
        "asset_type": "api_collection",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 7,
        "mcp_url": "https://www.workato.com/mcp/servers/sales-tools-mcp-server?token=newtoken789",
        "auth_type": "token",
        "idp_user_group_ids": [],
        "api_collection": null,
        "created_at": "2025-10-15T13:41:05.207-07:00",
        "updated_at": "2025-10-18T09:15:22.000-07:00"
    }
}

MCPサーバーへのユーザーグループの割り当て

IDプロバイダーのユーザーグループをMCPサーバーに割り当てます。 サーバーのauth_typeworkato_idpの場合にのみ適用されます。

shell
POST /api/mcp/mcp_servers/:handle/assign_user_groups

URLパラメータ

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

ペイロード

名前タイプ説明
idp_user_group_ids文字列の配列
必須
追加するユーザーグループのID。

リクエスト例

shell
curl  -X POST 'https://www.workato.com/api/mcp/mcp_servers/hr-automation-server/assign_user_groups' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "idp_user_group_ids": ["group-abc123", "group-def456"]
          }'

レスポンス例

割り当てられたユーザーグループIDがidp_user_group_idsに反映された、更新済みのMCPサーバーオブジェクトを返します。

json
{
    "data": {
        "id": 1002,
        "name": "HR Automation Server",
        "description": "HR onboarding and employee management tools",
        "asset_type": "project_asset",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 3,
        "mcp_url": "https://www.workato.com/mcp/servers/hr-automation-server?token=hrtoken456",
        "auth_type": "workato_idp",
        "idp_user_group_ids": ["group-abc123", "group-def456"],
        "api_collection": null,
        "created_at": "2025-10-15T10:00:00.000-07:00",
        "updated_at": "2025-10-18T10:30:00.000-07:00"
    }
}

MCPサーバーからのユーザーグループの削除

IDプロバイダーのユーザーグループをMCPサーバーから削除します。

shell
POST /api/mcp/mcp_servers/:handle/remove_user_groups

URLパラメータ

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

ペイロード

名前タイプ説明
idp_user_group_ids文字列の配列
必須
削除するユーザーグループのID。

リクエスト例

shell
curl  -X POST 'https://www.workato.com/api/mcp/mcp_servers/hr-automation-server/remove_user_groups' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "idp_user_group_ids": ["group-abc123"]
          }'

レスポンス例

指定されたグループがidp_user_group_idsから削除された、更新済みのMCPサーバーオブジェクトを返します。

json
{
    "data": {
        "id": 1002,
        "name": "HR Automation Server",
        "description": "HR onboarding and employee management tools",
        "asset_type": "project_asset",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 3,
        "mcp_url": "https://www.workato.com/mcp/servers/hr-automation-server?token=hrtoken456",
        "auth_type": "workato_idp",
        "idp_user_group_ids": ["group-def456"],
        "api_collection": null,
        "created_at": "2025-10-15T10:00:00.000-07:00",
        "updated_at": "2025-10-18T11:00:00.000-07:00"
    }
}

MCPサーバーの別フォルダへの移動

MCPサーバーを指定されたフォルダに移動します。

shell
PUT /api/mcp/mcp_servers/:handle/update_folder

URLパラメータ

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。

ペイロード

名前タイプ説明
folder_idnumber
必須
移動先フォルダID。

リクエスト例

shell
curl  -X PUT 'https://www.workato.com/api/mcp/mcp_servers/hr-automation-server/update_folder' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "folder_id": 27180399
          }'

レスポンス例

新しいfolder_idcreated_atおよびupdated_atタイムスタンプに反映された、更新済みのMCPサーバーオブジェクトを返します。

json
{
    "data": {
        "id": 1002,
        "name": "HR Automation Server",
        "description": "HR onboarding and employee management tools",
        "asset_type": "project_asset",
        "logo_url": "https://www.workato.com/images/mcp-server-logo.png",
        "tools_count": 3,
        "mcp_url": "https://www.workato.com/mcp/servers/hr-automation-server?token=hrtoken456",
        "auth_type": "workato_idp",
        "idp_user_group_ids": ["group-def456"],
        "api_collection": null,
        "created_at": "2025-10-15T10:00:00.000-07:00",
        "updated_at": "2025-10-18T12:00:00.000-07:00"
    }
}

サーバーポリシー設定の取得

MCPサーバーのセキュリティポリシー設定を取得します。これには、レート制限、クォータ制限、Classless Inter-Domain Routing(CIDR)、およびIPアドレスが含まれます。

shell
GET /api/mcp/mcp_servers/:mcp_server_handle/server_policies

URLパラメータ

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。

リクエスト例

shell
curl  -X GET 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server/server_policies' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例

json
{
    "id": 501,
    "mcp_server_id": 1001,
    "rate_limits": {
        "per_minute": 60
    },
    "quota_limits": {
        "per_day": 10000
    },
    "ip_allow_list": ["203.0.113.0/24"],
    "ip_deny_list": [],
    "created_at": "2025-10-15T13:41:05.207-07:00",
    "updated_at": "2025-10-16T09:22:11.100-07:00"
}

サーバーポリシー設定の更新

MCPサーバーのIPを含むセキュリティポリシー設定を更新します。

shell
PUT /api/mcp/mcp_servers/:mcp_server_handle/server_policies

URLパラメータ

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。

ペイロード

名前タイプ説明
mcp_server_policyobject
required
ポリシー設定オブジェクト。
mcp_server_policy[rate_limits]object
optional
レート制限設定。
mcp_server_policy[quota_limits]object
optional
クォータ制限設定。
mcp_server_policy[ip_allow_list]array of strings
optional
許可するIPアドレスまたはCIDR範囲。
mcp_server_policy[ip_deny_list]array of strings
optional
拒否するIPアドレスまたはCIDR範囲。

リクエスト例

shell
curl  -X PUT 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server/server_policies' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "mcp_server_policy": {
              "rate_limits": { "per_minute": 30 },
              "quota_limits": { "per_day": 5000 },
              "ip_allow_list": ["203.0.113.0/24", "198.51.100.42"],
              "ip_deny_list": []
            }
          }'

レスポンス例

json
{
    "id": 501,
    "mcp_server_id": 1001,
    "rate_limits": {
        "per_minute": 30
    },
    "quota_limits": {
        "per_day": 5000
    },
    "ip_allow_list": ["203.0.113.0/24", "198.51.100.42"],
    "ip_deny_list": [],
    "created_at": "2025-10-15T13:41:05.207-07:00",
    "updated_at": "2025-10-18T14:00:00.000-07:00"
}

MCPサーバーのツール一覧表示

MCPサーバーに割り当てられたツールのページネーションされたリストを返します。

shell
GET /api/mcp/mcp_servers/:mcp_server_handle/tools

URLパラメータ

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。

クエリパラメータ

名前タイプ説明
vua_requiredboolean
optional
Verified User Access(VUA)が必要かどうかでフィルタリングします。
searchstring
任意
ツールを名前でフィルタリングする検索語句。
pagenumber
optional
ページ番号。 デフォルトは1です。
per_pagenumber
optional
ページごとの項目数。 デフォルトは100です。 最大は100です。

リクエスト例

shell
curl  -X GET 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server/tools' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例

json
{
    "data": [
        {
            "id": 3001,
            "name": "Create Salesforce Lead",
            "description": "Creates a new lead record in Salesforce CRM",
            "trigger_application": "workato_api_platform",
            "action_applications": ["salesforce"],
            "flow_id": 66870001,
            "vua_required": false
        },
        {
            "id": 3002,
            "name": "Send Deal Notification",
            "description": "Sends a Slack notification when a deal stage changes",
            "trigger_application": "workato_recipe_function",
            "action_applications": ["slack"],
            "flow_id": 66870002,
            "vua_required": true
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 100
}

ツール説明の更新

MCPサーバー内のツールの説明を更新します。 基盤となるレシピやAPIエンドポイントに影響を与えずに、AIクライアントに表示される説明を変更します。

shell
PUT /api/mcp/mcp_servers/:mcp_server_handle/tools/:id

URLパラメータ

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。
idnumber
必須
ツールID。

ペイロード

名前タイプ説明
説明string
任意
ツールの新しい説明。

リクエスト例

shell
curl  -X PUT 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server/tools/3001' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "description": "Creates a new lead record in Salesforce CRM with name, email, and company details"
          }'

レスポンス例

json
{
    "id": 3001,
    "name": "Create Salesforce Lead",
    "description": "Creates a new lead record in Salesforce CRM with name, email, and company details",
    "trigger_application": "workato_api_platform",
    "action_applications": ["salesforce"],
    "flow_id": 66870001,
    "vua_required": false
}

ツールの削除

MCPサーバーからツールを削除します。

APIエンドポイントは削除できません

レシピ関数またはGenieを基盤とするツールのみ削除できます。 APIエンドポイントツールを削除しようとすると、400 Bad Requestエラーが返されます。

shell
DELETE /api/mcp/mcp_servers/:mcp_server_handle/tools/:id

URLパラメータ

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。
idnumber
必須
ツールID。

リクエスト例

shell
curl  -X DELETE 'https://www.workato.com/api/mcp/mcp_servers/sales-tools-mcp-server/tools/3002' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例

成功時に204 No Contentを返します。

IDプロバイダーユーザーグループの一覧表示

ワークスペースで使用可能なIDプロバイダーユーザーグループのページネーションされたリストを返します。 workato_idp認証を使用するMCPサーバーにアクセス権を割り当てる場合は、このレスポンスのグループIDを使用します。

shell
GET /api/mcp/user_groups

クエリパラメータ

名前タイプ説明
pagenumber
optional
ページ番号。 デフォルトは1です。
per_pagenumber
optional
ページごとの項目数。 デフォルトは100です。 最大は100です。

リクエスト例

shell
curl  -X GET 'https://www.workato.com/api/mcp/user_groups' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例

json
{
    "data": [
        {
            "id": "group-abc123",
            "name": "Sales Team",
            "users_count": 24,
            "created_at": "2025-01-10T08:00:00.000Z",
            "updated_at": "2025-09-15T12:30:00.000Z"
        },
        {
            "id": "group-def456",
            "name": "HR Admins",
            "users_count": 6,
            "created_at": "2025-01-10T08:00:00.000Z",
            "updated_at": "2025-08-20T10:00:00.000Z"
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 100
}

Last updated: