Smithery
tools.execute.create
Execute a specific tool operation with provided arguments and authentication. This is the primary endpoint for integrating with third-party services and executing tools. You can provide structured arguments or use natural language processing by providing a text description of what you want to accomplish.
Remote smithery/composio
Other tools also called tools.execute.create?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"text": {
"type": "string",
"example": "Trigger the main workflow in the octocat/Hello-World repository on the main branch for the production environment",
"description": "Natural language description of the task to perform (mutually exclusive with arguments)"
},
"user_id": {
"type": "string",
"example": "user-123",
"description": "User id for multi-user connected accounts (e.g. multiple users, organizations)"
},
"version": {
"type": "string",
"example": "latest",
"description": "Tool version to execute (defaults to \"00000000_00\" if not specified)"
},
"arguments": {
"type": "object",
"example": {
"ref": "main",
"inputs": {
"environment": "production"
},
"repository": "octocat/Hello-World",
"workflow_id": "main.yml"
},
"description": "Key-value pairs of arguments required by the tool (mutually exclusive with text)",
"additionalProperties": {
"nullable": true
}
},
"entity_id": {
"type": "string",
"example": "repo-123",
"deprecated": true,
"description": "Deprecated: please use user_id instead. Entity identifier for multi-entity connected accounts (e.g. multiple repositories, organizations)"
},
"tool_slug": {
"type": "string",
"description": "The tool slug to execute"
},
"allow_tracing": {
"type": "boolean",
"example": false,
"nullable": true,
"deprecated": true,
"description": "Deprecated. Enable debug tracing for tool execution (useful for debugging)"
},
"custom_auth_params": {
"type": "object",
"example": {
"base_url": "https://api.example.com",
"parameters": [
{
"in": "header",
"name": "x-api-key",
"value": "secret-key"
}
]
},
"properties": {
"body": {
"type": "object",
"description": "The body to be sent to the endpoint for authentication. This is a JSON object. Note: This is very rarely needed and is only required by very few apps.",
"additionalProperties": {
"nullable": true
}
},
"base_url": {
"type": "string",
"description": "The base URL (root address) what you should use while making http requests to the connected account. For example, for gmail, it would be 'https://gmail.googleapis.com'"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"in",
"value"
],
"properties": {
"in": {
"enum": [
"query",
"header"
],
"type": "string",
"description": "The location of the parameter. Can be 'query' or 'header'."
},
"name": {
"type": "string",
"description": "The name of the parameter. For example, 'x-api-key', 'Content-Type', etc."
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "The value of the parameter. For example, '1234567890', 'application/json', etc."
}
}
}
}
},
"description": "Custom authentication parameters for tools that support parameterized authentication"
},
"connected_account_id": {
"type": "string",
"example": "ca_1a2b3c4d5e6f",
"description": "Unique identifier for the connected account to use for authentication"
},
"custom_connection_data": {
"oneOf": [
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"access_token"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"scope": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"nullable": true
}
]
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"id_token": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"expires_in": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"nullable": true
}
]
},
"token_type": {
"type": "string"
},
"account_url": {
"type": "string"
},
"authed_user": {
"type": "object",
"properties": {
"scope": {
"type": "string"
},
"access_token": {
"type": "string"
}
},
"description": "for slack user scopes"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"access_token": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"state_prefix": {
"type": "string",
"maxLength": 40,
"description": "The oauth2 state prefix for the connection"
},
"COMPANYDOMAIN": {
"type": "string"
},
"refresh_token": {
"type": "string",
"nullable": true
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"extra_token_data": {
"type": "object",
"additionalProperties": {
"nullable": true
}
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"long_redirect_url": {
"type": "boolean",
"description": "Whether to return the redirect url without shortening"
},
"webhook_signature": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"OAUTH2"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"client_id",
"access_token"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"scope": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"nullable": true
}
]
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"id_token": {
"type": "string"
},
"client_id": {
"type": "string",
"description": "Dynamically registered client ID"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"expires_in": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"nullable": true
}
]
},
"token_type": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"access_token": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"state_prefix": {
"type": "string",
"maxLength": 40,
"description": "The oauth2 state prefix for the connection"
},
"COMPANYDOMAIN": {
"type": "string"
},
"client_secret": {
"type": "string",
"description": "Dynamically registered client secret"
},
"refresh_token": {
"type": "string",
"nullable": true
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"long_redirect_url": {
"type": "boolean",
"description": "Whether to return the redirect url without shortening"
},
"client_id_issued_at": {
"type": "number"
},
"borneo_dashboard_url": {
"type": "string"
},
"client_secret_expires_at": {
"type": "number"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"DCR_OAUTH"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_key": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"bearer_token": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"basic_encoded": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"generic_api_key": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"API_KEY"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"BASIC_WITH_JWT"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"username"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"BASIC"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"token"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"token": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"BEARER_TOKEN"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"oauth_token",
"oauth_token_secret"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"oauth_token": {
"type": "string"
},
"redirectUrl": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"callback_url": {
"type": "string"
},
"consumer_key": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"oauth_verifier": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"oauth_token_secret": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"OAUTH1"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"NO_AUTH"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"application_id",
"installation_id",
"private_key"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"private_key": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"application_id": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"installation_id": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"SERVICE_ACCOUNT"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"credentials_json"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"credentials_json": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"GOOGLE_SERVICE_ACCOUNT"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"authScheme",
"toolkitSlug",
"val"
],
"properties": {
"val": {
"type": "object",
"required": [
"access_token",
"client_id",
"client_secret"
],
"properties": {
"dc": {
"type": "string"
},
"shop": {
"type": "string"
},
"scope": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"nullable": true
}
]
},
"domain": {
"type": "string"
},
"region": {
"type": "string"
},
"api_url": {
"type": "string"
},
"version": {
"type": "string"
},
"base_url": {
"type": "string"
},
"client_id": {
"type": "string"
},
"extension": {
"type": "string"
},
"site_name": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"account_id": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"expires_in": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"nullable": true
}
]
},
"token_type": {
"type": "string"
},
"account_url": {
"type": "string"
},
"your-domain": {
"type": "string"
},
"your_server": {
"type": "string"
},
"access_token": {
"type": "string"
},
"instanceName": {
"type": "string"
},
"COMPANYDOMAIN": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"proxy_password": {
"type": "string"
},
"proxy_username": {
"type": "string"
},
"server_location": {
"type": "string"
},
"instanceEndpoint": {
"type": "string"
},
"form_api_base_url": {
"type": "string"
},
"borneo_dashboard_url": {
"type": "string"
}
},
"additionalProperties": {
"nullable": true
}
},
"authScheme": {
"enum": [
"S2S_OAUTH2"
],
"type": "string"
},
"toolkitSlug": {
"type": "string"
}
}
}
],
"example": {
"val": {
"access_token": "secret-token"
},
"authScheme": "OAUTH2",
"toolkitSlug": "github"
},
"description": "Custom connection data for tools that support custom connection data"
}
}
}