Developer API - MCPサーバー ​

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

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

トークン認証とハッシュ化トークン認証

hashed_tokenは、トークンベースのMCPサーバーのデフォルト認証タイプです。 token認証タイプはレガシーとみなされます。 tokenを使用している既存のサーバーは引き続き動作しますが、新しいサーバーはhashed_tokenを使用します。 hashed_tokenサーバーでトークンを管理する方法の詳細については、ハッシュ化トークンを作成するを参照してください。

クイックリファレンス ​

タイプリソース説明
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/:mcp_server_handle/tokensハッシュ化されたトークンを作成します。
DELETE/api/mcp/mcp_servers/:mcp_server_handle/tokens/:idハッシュ化されたトークンを削除します。
POST/api/mcp/mcp_servers/:mcp_server_handle/tokens/:id/refreshハッシュ化されたトークンを更新します。
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プロバイダーのユーザーグループを一覧表示します。
GET/api/mcp/mcp_servers/:mcp_server_handle/access_assignmentsMCPアクセス割り当てを一覧表示します。
POST/api/mcp/mcp_servers/:mcp_server_handle/access_assignmentsMCPアクセス割り当てを作成します。
GET/api/mcp/mcp_servers/:mcp_server_handle/access_assignments/:idMCPアクセス割り当てを取得します。
PUT/api/mcp/mcp_servers/:mcp_server_handle/access_assignments/:idMCPアクセス割り当てを更新します。
DELETE/api/mcp/mcp_servers/:mcp_server_handle/access_assignments/:idMCPアクセス割り当てを削除します。

MCPサーバーの一覧表示 ​

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

GET https://YOUR_DATA_CENTER/api/mcp/mcp_servers

クエリパラメーター ​

名前タイプ説明
project_idnumber
optional
プロジェクトIDでフィルタリングします。
folder_idnumber
optional
フォルダIDでフィルタリングします。
authentication_methodstring
optional
認証方法でフィルタリングします。使用可能な値: hashed_token、token(レガシー)、workato_idp。
pagenumber
optional
ページ番号。デフォルトは1です。
per_pagenumber
optional
ページごとの項目数。最大値は50です。

サンプルリクエスト ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers?folder_id=:folder_id_value' \
      -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": "hashed_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サーバーを作成します。

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers

ペイロード ​

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

デフォルトの認証タイプとしてのハッシュ化トークン

MCPサーバーは、別の認証タイプを指定しない限り、デフォルトのauth_typeとしてhashed_tokenを使用します。 hashed_tokenサーバーでトークンを管理するには、MCPハッシュ化トークンエンドポイントを使用します。

リクエスト例 ​

shell
curl  -X POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": ":name",
            "description": ":description",
            "folder_id": :folder_id_value,
            "tools": [
              {
                "trigger_application": ":trigger_application",
                "id": ":tool_id"
              }
            ]
          }'

レスポンス例 ​

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": "hashed_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サーバーの詳細を取得します。

GET https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

リクエスト例 ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle' \
      -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": "hashed_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サーバーを更新します。

PUT https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

名前タイプ説明
namestring
optional
サーバー名。
説明string
optional
サーバーの説明。
auth_typestring
optional
認証タイプ。使用可能な値: hashed_token(デフォルト)、token(レガシー)、workato_idp。
idp_user_group_idsarray of strings
optional
サーバーにアクセスできるIDプロバイダーユーザーグループID。 auth_typeがworkato_idpの場合にのみ適用されます。
folder_idnumber
optional
サーバーの移動先フォルダID。

レガシー認証タイプ

Workatoは後方互換性のためにtoken auth_typeを保持しています。新しいサーバーではhashed_tokenを使用してください。既存のサーバーのauth_typeをhashed_tokenに切り替えるには、MCPハッシュ化トークンエンドポイントでトークンプロファイルを作成します。 hashed_tokenサーバーは、単一のサーバーレベルのトークンではなく、個別に名前が付けられた取り消し可能なトークンプロファイルを使用します。

リクエスト例 ​

shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": ":name",
            "description": ":description",
            "auth_type": ":auth_type"
          }'

レスポンス例 ​

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": "hashed_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サーバーを削除します。

DELETE https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

リクエスト例 ​

shell
curl  -X DELETE 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例 ​

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

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

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

レガシーエンドポイント

このエンドポイントは、単一のサーバーレベルのトークンを持つレガシーtoken認証タイプを使用するサーバーに適用されます。 hashed_tokenサーバーでは、個別の名前付きトークンプロファイルを操作するハッシュ化トークンを更新するを使用します。

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/token_renew

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

リクエスト例 ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/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ハッシュ化トークン ​

MCPハッシュ化トークンエンドポイントは、auth_typeがhashed_tokenであるMCPサーバーの個別の名前付きトークンプロファイルを管理します。これはレガシーな token 認証タイプからの更新であり、レガシー方式では単一のサーバーレベルトークンをトークンの更新を通じて管理します。 hashed_tokenは、サーバーごとに最大50個の名前付きで個別に取り消し可能なトークンプロファイルをサポートします。

ハッシュ化トークンを作成する ​

auth_typeがhashed_tokenであるサーバーのトークンプロファイルを作成します。

MCPサーバーは、最大50個のアクティブなハッシュ化トークンをサポートします。

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tokens

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

名前タイプ説明
namestring
必須
トークンプロファイル名。空白不可、100文字以下、かつサーバーのアクティブなトークン内で大文字と小文字を区別せずに一意である必要があります。

追加の制約 ​

このエンドポイントはhashed_tokenサーバーでのみ使用できます。このエンドポイントをtokenまたはworkato_idpサーバーで呼び出すとエラーが返されます。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tokens' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": ":name"
          }'

サンプルレスポンス ​

dataの下にネストされるのではなく、レスポンスルートにトークンプロファイルを含む201 Createdを返します。

json
{
    "id": 731,
    "name": "Production token",
    "auth_type": "hashed_token",
    "created_at": "2026-07-10T10:00:00.000Z",
    "created_by": {
        "id": 42,
        "full_name": "Example User"
    },
    "token_first_symbols": "abc",
    "token_last_symbols": "wxyz",
    "plain_token": "<plain_token>"
}

プレーンテキストトークンは一度だけ表示されます

plain_tokenは作成時にのみ返され、後で取得することはできません。トークンを安全に保存してください。必要に応じて新しいトークンを生成するには、トークンを更新するエンドポイントを使用できます。

ハッシュ化トークンを削除する ​

ハッシュ化トークンを削除しても、データベースからは削除されません。ハッシュ化トークンプロファイルは非アクティブとしてマークされます。トークンは直ちに機能しなくなり、MCPリクエストの認証に使用できなくなります。

DELETE https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tokens/:id

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。
idnumber
必須
トークンプロファイルID。

サンプルリクエスト ​

shell
curl  -X DELETE 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tokens/:id' \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

空のレスポンス本文で200 OKを返します。

このエンドポイントはhashed_tokenサーバーでのみ使用できます。削除されたプロファイルは、サーバーのmcp_profiles配列に表示されなくなります。

ハッシュ化トークンを更新する ​

プロファイルの現在のトークン値を無効化し、新しいプレーンテキストトークンを返します。

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tokens/:id/refresh

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。
idnumber
必須
アクティブなトークンプロファイルID。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tokens/:id/refresh' \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

200 OKを返します。レスポンスはトークン作成と同じルートレベルの形状で、plain_token、token_first_symbols、token_last_symbolsを含みます。

json
{
    "id": 731,
    "name": "Production token",
    "auth_type": "hashed_token",
    "created_at": "2026-07-10T10:00:00.000Z",
    "created_by": {
        "id": 42,
        "full_name": "Example User"
    },
    "token_first_symbols": "def",
    "token_last_symbols": "uvwx",
    "plain_token": "<new_plain_token>"
}

このエンドポイントはhashed_tokenサーバーでのみ使用できます。返されたplain_tokenは、このレスポンスでのみ公開されます。後で取得できないため、トークンは安全に保存してください。

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

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

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/assign_tools

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

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

リクエスト例 ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/assign_tools' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "tools": [
              {
                "trigger_application": ":trigger_application_1",
                "id": ":tool_id_1"
              },
              {
                "trigger_application": ":trigger_application_2",
                "id": ":tool_id_2"
              }
            ]
          }'

レスポンス例 ​

更新済みの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": "hashed_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_typeがworkato_idpの場合にのみ適用されます。

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/assign_user_groups

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

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

リクエスト例 ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/assign_user_groups' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "idp_user_group_ids": [":user_group_id_1", ":user_group_id_2"]
          }'

レスポンス例 ​

割り当てられたユーザーグループ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サーバーから削除します。

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/remove_user_groups

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

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

リクエスト例 ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/remove_user_groups' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "idp_user_group_ids": [":user_group_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-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サーバーを指定されたフォルダに移動します。

PUT https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/update_folder

URLパラメータ ​

名前タイプ説明
handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

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

リクエスト例 ​

shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:handle/update_folder' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "folder_id": :folder_id_value
          }'

レスポンス例 ​

新しいfolder_idがcreated_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アドレスが含まれます。

GET https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/server_policies

URLパラメータ ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

リクエスト例 ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/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を含むセキュリティポリシー設定を更新します。

PUT https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/server_policies

URLパラメータ ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

名前タイプ説明
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://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/server_policies' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "mcp_server_policy": {
              "rate_limits": { "per_minute": :per_minute_value },
              "quota_limits": { "per_day": :per_day_value },
              "ip_allow_list": [":ip_allow_1", ":ip_allow_2"],
              "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サーバーに割り当てられたツールのページネーションされたリストを返します。

GET https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tools

URLパラメータ ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

クエリパラメータ ​

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

リクエスト例 ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/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クライアントに表示される説明を変更します。

PUT https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tools/:id

URLパラメータ ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。
idnumber
必須
ツールID。

ペイロード ​

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

リクエスト例 ​

shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tools/:id' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "description": ":description"
          }'

レスポンス例 ​

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エラーが返されます。

DELETE https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tools/:id

URLパラメータ ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。
idnumber
必須
ツールID。

リクエスト例 ​

shell
curl  -X DELETE 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/tools/:id' \
      -H 'Authorization: Bearer <api_token>'

レスポンス例 ​

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

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

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

GET https://YOUR_DATA_CENTER/api/mcp/user_groups

クエリパラメータ ​

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

リクエスト例 ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/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
}

MCPアクセス割り当て ​

MCPアクセス割り当ては、MCPサーバーに対するツールレベルのロールベースアクセス制御(RBAC)を管理します。各割り当ては、アイデンティティプロバイダーのユーザーまたはユーザーグループ1件に対して、そのMCPサーバー上のすべてのツールまたは特定のツールセットへのアクセスを付与します。

要件と制限

  • アクセス割り当ては、auth_type に workato_idp を使用するMCPサーバーでのみ動作します。
  • アクセス割り当ては、api_collection ベースのMCPサーバーでは動作しません。
  • アイデンティティは、サーバーごとに1件のアクセス割り当てしか持てません。

MCPアクセス割り当ての一覧 ​

ユーザーまたはユーザーグループに対するMCPサーバーアクセス割り当てのページ分割された一覧を返します。

必要な権限: mcp_access_assignments.index。

GET https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/access_assignments

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

クエリパラメーター ​

名前タイプ説明
identity_typestring
必須
アイデンティティタイプ。許可される値: user、user_group。
searchstring
optional
アイデンティティ名を検索します。
orderstring
optional
アイデンティティ名でソートします。許可される値: asc、desc。デフォルトはascです。
pageinteger
optional
正のページ番号。デフォルトは1です。
per_pageinteger
optional
ページあたりのアイテム数。1から100まで。デフォルトは100です。

サンプルリクエスト ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/mcps-7Hk9pQ2r-aB3-1a/access_assignments?identity_type=user_group&page=1&per_page=100' \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

200 OKを返します。

json
{
    "data": [
        {
            "id": "mcpsaa-7Hk9pQ2s-aB3cD4-1a",
            "idp_user_id": null,
            "idp_user_group_id": "group-abc123",
            "all_tools": false,
            "tool_ids": [3001, 3002],
            "created_at": "2026-10-09T10:00:00.000Z",
            "updated_at": "2026-10-09T10:00:00.000Z"
        },
        {
            "id": "mcpsaa-7Hk9pQ2u-jK7mN8-1a",
            "idp_user_id": null,
            "idp_user_group_id": "group-def456",
            "all_tools": true,
            "tool_ids": [],
            "created_at": "2026-10-09T10:00:00.000Z",
            "updated_at": "2026-10-09T10:00:00.000Z"
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 100
}

この例では、グループへの割り当てを一覧表示しています。 identity_type を user に設定すると、その割り当てにはユーザーIDを含む idp_user_id 文字列と、null値の idp_user_group_id が含まれます。両方のアイデンティティフィールドはデフォルトで含まれます。

MCPアクセス割り当ての作成 ​

MCPサーバー上のユーザーまたはユーザーグループに対するアクセス割り当てを1件作成します。

必要な権限: mcp_access_assignments.create。

POST https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/access_assignments

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。

ペイロード ​

名前タイプ説明
idp_user_idstring
conditional
空でないアイデンティティプロバイダーユーザーID。 idp_user_id と idp_user_group_id のうち、いずれか一方のみを指定します。
idp_user_group_idstring
conditional
空でないアイデンティティプロバイダーユーザーグループID。 idp_user_id と idp_user_group_id のうち、いずれか一方のみを指定します。
all_toolsboolean
optional
サーバー上のすべてのツールへのアクセスを付与します。デフォルトはfalseです。
tool_ids整数の配列
条件付き
all_tools が false または省略されている場合に必須で、かつ空であってはなりません。 all_tools が true の場合、このフィールドは省略するか、空の配列を送信します。すべてのIDはこのサーバーに属している必要があります。ツールIDを取得するには、List tools エンドポイントを使用します。

追加の制約事項 ​

  • アイデンティティは対象Environment内で有効である必要があります。
  • アイデンティティは、サーバーごとに1件の割り当てしか持てません。
  • ツールIDは、そのサーバーのMCPツールレコードを指し、レシピIDやAPIエンドポイントIDではありません。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/mcps-7Hk9pQ2r-aB3-1a/access_assignments' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "idp_user_group_id": "group-abc123",
            "all_tools": false,
            "tool_ids": [3001, 3002]
          }'

ユーザーにすべてのツールへのアクセスを付与するには、次のリクエストボディを使用します。

json
{
    "idp_user_id": "user-abc123",
    "all_tools": true
}

サンプルレスポンス ​

201 Created を返します。

json
{
    "data": {
        "id": "mcpsaa-7Hk9pQ2s-aB3cD4-1a",
        "idp_user_id": null,
        "idp_user_group_id": "group-abc123",
        "all_tools": false,
        "tool_ids": [3001, 3002],
        "created_at": "2026-10-09T10:00:00.000Z",
        "updated_at": "2026-10-09T10:00:00.000Z"
    }
}

割り当てIDはサーバー側で生成されます。ツールIDは重複排除され、ソートされます。

MCPアクセス割り当ての取得 ​

MCPサーバーに属するアクセス割り当てを取得します。

必要な権限: mcp_access_assignments.show。

GET https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/access_assignments/:id

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。
idstring
必須
このサーバーに属するアクセス割り当てID。

このエンドポイントは、クエリパラメーターやボディパラメーターを受け付けません。

サンプルリクエスト ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/mcps-7Hk9pQ2r-aB3-1a/access_assignments/mcpsaa-7Hk9pQ2s-aB3cD4-1a' \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

200 OKを返します。

json
{
    "data": {
        "id": "mcpsaa-7Hk9pQ2s-aB3cD4-1a",
        "idp_user_id": null,
        "idp_user_group_id": "group-abc123",
        "all_tools": false,
        "tool_ids": [3001, 3002],
        "created_at": "2026-10-09T10:00:00.000Z",
        "updated_at": "2026-10-09T10:00:00.000Z"
    }
}

ユーザーへの割り当てでは、ユーザーIDを含む idp_user_id フィールドと、デフォルトで null 値を持つ idp_user_group_id フィールドの両方が含まれます。すべてのツールを付与する割り当てでは、all_tools: true と tool_ids: [] になります。

MCPアクセス割り当ての更新 ​

既存のMCPサーバーアクセス割り当てのツールアクセススコープ全体を置き換えます。

必要な権限: mcp_access_assignments.update。

PUT https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/access_assignments/:id

このパスは、同じ置換動作で PATCH も受け付けます。

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。
idstring
必須
このサーバーに属するアクセス割り当てID。

ペイロード ​

名前タイプ説明
all_toolsboolean
optional
サーバー上のすべてのツールへのアクセスを付与します。省略された場合のデフォルトは false です。
tool_ids整数の配列
条件付き
all_tools が false または省略されている場合に必須で、かつ空であってはなりません。 all_tools が true の場合、このフィールドは省略するか、空の配列を送信します。すべてのIDはこのサーバーに属している必要があります。

更新はツールスコープ全体を置き換えます

all_tools と tool_ids のうち、少なくとも一方は指定します。省略されたフィールドは保持されません。 all_tools を省略した場合はデフォルトで false になり、tool_ids を省略した場合はデフォルトで空の配列になります。既存の割り当てでアイデンティティを変更することはできません。

サンプルリクエスト ​

shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/mcps-7Hk9pQ2r-aB3-1a/access_assignments/mcpsaa-7Hk9pQ2s-aB3cD4-1a' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "all_tools": false,
            "tool_ids": [3001]
          }'

すべてのツールを付与するには、{"all_tools": true} を送信します。その場合、レスポンスには all_tools: true と tool_ids: [] が含まれます。

サンプルレスポンス ​

200 OKを返します。

json
{
    "data": {
        "id": "mcpsaa-7Hk9pQ2s-aB3cD4-1a",
        "idp_user_id": null,
        "idp_user_group_id": "group-abc123",
        "all_tools": false,
        "tool_ids": [3001],
        "created_at": "2026-10-09T10:00:00.000Z",
        "updated_at": "2026-10-09T11:00:00.000Z"
    }
}

割り当てのアイデンティティと作成タイムスタンプは変更されません。

MCPアクセス割り当ての削除 ​

MCPサーバーから、ユーザーまたはユーザーグループのアクセス割り当てを削除します。

必要な権限: mcp_access_assignments.destroy。

DELETE https://YOUR_DATA_CENTER/api/mcp/mcp_servers/:mcp_server_handle/access_assignments/:id

URLパラメーター ​

名前タイプ説明
mcp_server_handlestring
必須
MCPサーバーハンドル。使用するMCPサーバーを選択するときに AI Hub > Enterprise MCP > Custom servers に移動すると、URL内で mcp_server_handle を見つけることができます。例えば、URL が https://app.workato.com/mcp/mcps-AxbxNxNz-wsB-SM/overview の場合、MCPサーバーハンドルは mcps-AxbxNxNz-wsB-SM です。
idstring
必須
このサーバーに属するアクセス割り当てID。

このエンドポイントは、クエリパラメーターやボディパラメーターを受け付けません。

サンプルリクエスト ​

shell
curl  -X DELETE 'https://YOUR_DATA_CENTER/api/mcp/mcp_servers/mcps-7Hk9pQ2r-aB3-1a/access_assignments/mcpsaa-7Hk9pQ2s-aB3cD4-1a' \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

成功すると 204 No Content を返し、レスポンスボディは空になります。

最終更新日: