Skip to Content

ArcadeEngineApi

Description: Tools that enable LLMs to interact directly with the engine API.

Author: Arcade

Auth: API Key

PyPI VersionLicensePython VersionsWheel StatusDownloads

EngineApi is a Starter MCP Server: each tool mirrors one HTTP endpoint and offers LLMs a way to interact with the low-level API.


Differently from Optimized MCP Servers, Starter tools are heavily influenced by the original API design, which is not usually optimized for LLM usage. For this reason, we recommend thoroughly evaluating the tools with your Agents or chatbots before using it in production. Read more about Optimized vs Starter tools.

The EngineApi Server offers a comprehensive suite of for managing authentication providers, secrets, and worker configurations. and LLMs can perform a variety of actions, including:

Available Tools

Tool NameDescription
EngineApi.ListAvailableAuthProvidersRetrieve a list of available authentication providers.
EngineApi.CreateAuthProviderCreate a new authentication provider.
EngineApi.GetAuthProviderDetailsRetrieve details of a specific authentication provider.
EngineApi.DeleteAuthProviderDelete a specific auth provider by ID.
EngineApi.UpdateAuthProviderUpdate an existing authentication provider.
EngineApi.ListVisibleSecretsRetrieve all secrets visible to the caller.
EngineApi.DeleteSecretByIdDeletes a secret using its unique ID.
EngineApi.ManageSecretCreate or update a stored secret key-value pair.
EngineApi.GetSessionVerificationSettingsRetrieve current session verification settings.
EngineApi.UpdateSessionVerificationSettingsUpdate session verification settings for a user.
EngineApi.ListAuthConnectionsRetrieve all authentication connections for users.
EngineApi.DeleteUserAuthConnectionDeletes a user/auth provider connection.
EngineApi.StartAuthorizationProcessStarts the authorization process for given requirements.
EngineApi.ConfirmUserAuthenticationConfirms a user's details during an authorization flow.
EngineApi.CheckAuthStatusVerify the ongoing authorization status of a tool.
EngineApi.OpenaiChatInteractionEngage with language models using OpenAI's chat API.
EngineApi.GetEngineConfigurationFetch the current engine configuration settings.
EngineApi.RetrieveFormattedToolsListFetches a formatted list of tools from engine configuration.
EngineApi.GetFormattedToolSpecificationFetches a formatted specification for a given tool.
EngineApi.CheckArcadeEngineHealthCheck the health status of the Arcade Engine.
EngineApi.GetModelContextProtocolFetch data from the Model Context Protocol endpoint.
EngineApi.ModelContextProtocolStreamAccess the Model Context Protocol for streaming data.
EngineApi.DeleteMcpEndpointDelete the Model Context Protocol endpoint data.
EngineApi.ListAccessibleProjectsRetrieve a list of accessible projects.
EngineApi.GetProjectDetailsRetrieve detailed information about a specific project.
EngineApi.GetScheduledToolExecutionsFetch a list of scheduled tool executions.
EngineApi.GetScheduledToolDetailsRetrieve details for a specific scheduled tool execution.
EngineApi.GetSwaggerSpecificationRetrieve the Swagger JSON specification for the API.
EngineApi.GetToolsListRetrieve a list of tools from the engine configuration.
EngineApi.AuthorizeUserToolAccessAuthorize a user to access a specific tool.
EngineApi.ExecuteToolExecute a specified tool with given parameters.
EngineApi.GetToolSpecificationRetrieve the specification for a specific arcade tool.
EngineApi.ListWorkersRetrieve a list of all workers with their definitions.
EngineApi.CreateWorkerCreate a new worker in the system.
EngineApi.TestWorkerConnectionTest a worker connection before adding it to the system.
EngineApi.GetWorkerByIdRetrieve worker details using their ID.
EngineApi.DeleteWorkerDeletes a specified worker from the system.
EngineApi.UpdateWorkerDetailsUpdate or modify details of a specific worker.
EngineApi.AuthorizeWorkerAuthorize a worker based on their ID.
EngineApi.GetWorkerHealthStatusRetrieve the health status of a worker.
EngineApi.FetchToolsPageRetrieve a list of tools for a specific worker.

If you need to perform an action that’s not listed here, you can get in touch with us to request a new , or create your own tools.

EngineApi.ListAvailableAuthProviders


Retrieve a list of available authentication providers.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.CreateAuthProvider


Create a new authentication provider.

Parameters

  • mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
  • request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetAuthProviderDetails


Retrieve details of a specific authentication provider.

Parameters

  • auth_provider_id (string, required) The ID of the authentication provider to retrieve.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.DeleteAuthProvider


Delete a specific by ID.

Parameters

  • auth_provider_id (string, required) The ID of the authentication provider to delete.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.UpdateAuthProvider


Update an existing authentication provider.

Parameters

  • mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
  • request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ListVisibleSecrets


Retrieve all secrets visible to the caller.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.DeleteSecretById


Deletes a secret using its unique ID.

Parameters

  • secret_id (string, required) The unique identifier of the secret to delete.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ManageSecret


Create or update a stored secret key-value pair.

Parameters

  • secret_key (string, required) The key of the secret to be created or updated in the storage system. It should be a unique identifier for the secret.
  • secret_value (string, required) The new or updated value of the secret to be stored. It should be a string containing the secret information.
  • secret_description (string, optional) A description of the secret. Provide details about the secret’s purpose or .

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetSessionVerificationSettings


Retrieve current session verification settings.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.UpdateSessionVerificationSettings


Update session verification settings for a .

Parameters

  • unsafe_skip_verification (boolean, optional) Set to true to skip the session verification, making it unsafe.
  • verifier_url (string, optional) The URL of the verifier service used for session verification. Provide a valid URL.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ListAuthConnections


Retrieve all authentication connections for .

Parameters

  • page_offset (integer, optional) The starting point in the list for pagination. Useful for retrieving subsequent pages of data.
  • page_size (integer, optional) Number of auth connections to return per page. Use to control the size of the result set.
  • provider_id (string, optional) Unique identifier for the authentication provider.
  • user_id (string, optional) The unique identifier for the to list authentication connections for.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.DeleteUserAuthConnection


Deletes a user/ connection.

Parameters

  • connection_id (string, required) The unique identifier for the user/ connection to be deleted.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.StartAuthorizationProcess


Starts the authorization process for given requirements.

Parameters

  • user_id (string, required) Unique identifier for the . Required to start the authorization process.
  • authorization_provider_id (string, optional) The provider ID for authorization. One of ID or ProviderID must be set.
  • authorization_provider_type (string, optional) Specifies the type of authorization provider to be used, such as ‘OAuth2’, ‘SAML’, etc.
  • authorization_requirement_id (string, optional) Set this ID for initiating authorization. Either this ID or the provider ID must be set.
  • oauth2_scopes (array[string], optional) A list of OAuth2 scopes that specify the level of access required for the authorization. Each scope should be provided as a string.
  • redirection_uri_after_authorization (string, optional) Optional URI to redirect the after authorization. If provided, the user will be redirected to this specific address once the authorization process is complete.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ConfirmUserAuthentication


Confirms a ’s details during an authorization flow.

Parameters

  • authorization_flow_id (string, required) A unique identifier for the authorization flow to confirm the ’s details.
  • user_identifier (string, required) The unique identifier for the to be confirmed during authentication.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.CheckAuthStatus


Verify the ongoing authorization status of a .

Parameters

  • authorization_id (string, required) The unique ID for the authorization process to check its status.
  • timeout_in_seconds (integer, optional) Specify the timeout duration in seconds. Maximum allowed is 59 seconds.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.OpenaiChatInteraction


Engage with language models using OpenAI’s chat API.

Parameters

  • mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
  • request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetEngineConfiguration


Fetch the current engine configuration settings.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.RetrieveFormattedToolsList


Fetches a formatted list of from engine configuration.

Parameters

  • filter_by_toolkit (string, optional) Specify the toolkit name to filter the list of .
  • number_of_items_to_return (integer, optional) Specify the number of to return. Defaults to 25, with a maximum of 100.
  • offset_start_index (integer, optional) Offset from the start of the list. Default is 0.
  • provider_format (string, optional) Format the according to the provider’s specifications. Accepts a string value.
  • user_identifier (string, optional) The ID of the user for whom the list is to be retrieved.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetFormattedToolSpecification


Fetches a formatted specification for a given .

Parameters

  • tool_name (string, required) The name of the for which the formatted specification is requested.
  • provider_format (string, optional) Specifies the format of the as required by the provider.
  • user_id (string, optional) The identifier for the user requesting the specification. This should be a string.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.CheckArcadeEngineHealth


Check the health status of the .

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetModelContextProtocol


Fetch data from the Protocol endpoint.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ModelContextProtocolStream


Access the Protocol for streaming data.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.DeleteMcpEndpoint


Delete the Protocol endpoint data.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ListAccessibleProjects


Retrieve a list of accessible .

Parameters

  • bearer_token (string, required) A string containing the Bearer (JWT) token for authentication.
  • items_to_skip (integer, optional) The number of to skip before starting to collect the result set.
  • maximum_items_to_return (integer, optional) Specifies the maximum number of to return. Must be an integer.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetProjectDetails


Retrieve detailed information about a specific .

Parameters

  • authorization_token (string, required) JWT token required for authentication. Should be provided in the format: ‘Bearer <token>’.
  • project_id (string, required) The unique identifier for the to retrieve details for. This should be a string matching the project’s ID in the database.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetScheduledToolExecutions


Fetch a list of scheduled executions.

Parameters

  • items_limit (integer, optional) The number of scheduled executions to return. Defaults to 25, max is 100.
  • list_offset (integer, optional) The starting position in the list of scheduled executions, default is 0.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetScheduledToolDetails


Retrieve details for a specific scheduled execution.

Parameters

  • scheduled_execution_id (string, required) The unique identifier for the scheduled execution to retrieve details for.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetSwaggerSpecification


Retrieve the Swagger JSON specification for the API.

Parameters

This does not take any parameters. Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetToolsList


Retrieve a list of from the engine configuration.

Parameters

  • include_formats (array[string], optional) List of formats to include in the response, specified by their names.
  • items_per_page (integer, optional) Specify the number of to return, with a maximum of 100. Defaults to 25 if not specified.
  • start_offset (integer, optional) Offset to determine the starting point from the list of . Default is 0.
  • toolkit_name (string, optional) Specifies the name of the toolkit to filter the list.
  • user_id (string, optional) The ID of the user requesting the tool list. It is used to filter the results for a specific user .

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.AuthorizeUserToolAccess


Authorize a user to access a specific .

Parameters

  • tool_name_for_authorization (string, required) Specify the name of the to authorize the for access.
  • redirect_uri_after_authorization (string, optional) Optional URI to redirect the after authorization.
  • tool_version (string, optional) Specify the version to authorize. If not provided, any version will be used.
  • user_id (string, optional) The unique identifier for a user. Required only when using an for authorization.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ExecuteTool


Execute a specified with given parameters.

Parameters

  • mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
  • request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetToolSpecification


Retrieve the specification for a specific arcade .

Parameters

  • tool_name (string, required) The name of the whose specification is to be retrieved. This should match the tool’s registered name.
  • formats_to_include (array[string], optional) List of formats to include in the response. Provide formats as a list of strings.
  • user_identifier (string, optional) The unique identifier for the user requesting the specification.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.ListWorkers


Retrieve a list of all workers with their definitions.

Parameters

  • number_of_items_to_return (integer, optional) The maximum number of worker items to return, with a default of 25 and a maximum of 100.
  • start_offset (integer, optional) Offset from the start of the list for pagination. Defaults to 0.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.CreateWorker


Create a new worker in the system.

Parameters

  • worker_id (string, required) A unique identifier for the worker to be created. It should be a string.
  • enable_worker (boolean, optional) Set to true to enable the new worker upon creation, or false to keep it disabled.
  • http_retry_attempts (integer, optional) Number of retry attempts for HTTP requests if a failure occurs.
  • http_secret_key (string, optional) A secret key used for HTTP authentication and authorization. It should be a secure string provided by the service.
  • http_timeout_seconds (integer, optional) The timeout duration for the HTTP connection, specified in seconds. This defines how long the system should wait for the HTTP request to complete before timing out.
  • mcp_retry_attempts (integer, optional) Specifies the number of retry attempts for connections. Provide an integer value to define how many times the system should retry a connection if it fails.
  • mcp_timeout_duration (integer, optional) The timeout duration for operations in seconds. Must be an integer value.
  • worker_http_uri (string, optional) The HTTP URI for the worker’s endpoint. This expects a valid URL string that specifies where the worker’s service can be accessed.
  • worker_resource_uri (string, optional) The URI for the worker’s resource location or service endpoint. Provide the full URI as a string.
  • worker_type (string, optional) Specifies the type of worker to be created. It should be a string indicating the category or role of the worker.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.TestWorkerConnection


Test a worker connection before adding it to the system.

Parameters

  • worker_connection_type (string, required) Specify the type of worker connection to test. It must be a string value indicating the category or mode of the worker.
  • http_uri (string, optional) Specify the HTTP URI of the worker to test the connection.
  • mcp_uri (string, optional) The URI for the connection required to test a worker connection.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetWorkerById


Retrieve worker details using their ID.

Parameters

  • worker_id (string, required) The unique identifier for the worker to retrieve details.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.DeleteWorker


Deletes a specified worker from the system.

Parameters

  • worker_id (string, required) The unique identifier for the worker to be deleted.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.UpdateWorkerDetails


Update or modify details of a specific worker.

Parameters

  • worker_id (string, required) Unique identifier for the worker to be updated.
  • enable_worker (boolean, optional) Set to ‘true’ to enable the worker or ‘false’ to disable it.
  • http_retry_attempts (integer, optional) Specify the number of retry attempts for HTTP requests.
  • http_timeout_duration (integer, optional) The duration in seconds for the HTTP request timeout for updating a worker. Use an integer to specify the time limit.
  • http_webhook_secret (string, optional) The secret key for authenticating HTTP webhook requests. It should be a secure string shared between sender and receiver.
  • mcp_retry_attempts (integer, optional) Set the number of retry attempts for the connection during update.
  • mcp_timeout_duration (integer, optional) Set the request timeout duration in seconds. Expect an integer value.
  • mcp_uri (string, optional) The URI for the (Message Control Protocol) endpoint to interact with the worker’s messaging system.
  • worker_http_uri (string, optional) The HTTP URI for the worker’s endpoint. Provide a valid URI string.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.AuthorizeWorker


Authorize a worker based on their ID.

Parameters

  • worker_id (string, required) The unique identifier for the worker to be authorized.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.GetWorkerHealthStatus


Retrieve the health status of a worker.

Parameters

  • worker_id (string, required) The unique identifier for the worker whose health status you want to check.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

EngineApi.FetchToolsPage


Retrieve a list of for a specific worker.

Parameters

  • worker_id (string, required) The unique ID of the worker for which to retrieve the list.
  • number_of_items (integer, optional) Number of items to return in the result set. Default is 25 and the maximum is 100.
  • start_offset (integer, optional) Offset from the start of the list for pagination. Defaults to 0.

Secrets

This requires the following secrets: ARCADE_API_KEY (learn how to configure secrets)

Secrets

This Server requires the ARCADE_API_KEY secret to be configured. Learn how to configure secrets.

Getting your Arcade API Key

To use the Arcade Engine API Server, you need an Arcade API key. This key authenticates your requests to the .

Learn how to create and manage your Arcade in the API Keys documentation.

Reference

Below is a reference of enumerations used by some of the tools in the ArcadeEngineApi Server:

ToolMode

  • GET_REQUEST_SCHEMA: get_request_schema
  • EXECUTE: execute
Last updated on