Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| LOG_LEVEL | No | Logging level | INFO |
| ALTERYX_API_HOST | No | Alternative name for Alteryx Server API URL | |
| ALTERYX_CLIENT_ID | No | OAuth2 Client ID for Alteryx Server authentication | |
| ALTERYX_SERVER_URL | No | Alteryx Server API URL | |
| ALTERYX_VERIFY_SSL | No | Whether to verify SSL certificates | 1 |
| ALTERYX_CLIENT_SECRET | No | OAuth2 Client Secret for Alteryx Server authentication |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_all_collections | Get the list of all collections of the Alteryx server |
| get_collection_by_id | Get a collection by its ID |
| create_collection | Create a new collection |
| delete_collection | Delete a collection by its ID |
| update_collection_name_or_owner | Update a collection name or owner by its ID |
| add_workflow_to_collection | Add a workflow to a collection by its ID |
| remove_workflow_from_collection | Remove a workflow from a collection by its ID |
| add_schedule_to_collection | Add a schedule to a collection by its ID |
| remove_schedule_from_collection | Remove a schedule from a collection by its ID |
| get_all_workflows | Get the list of all workflows of the Alteryx server |
| get_workflow_by_id | Get a workflow by its ID |
| update_workflow_name_or_comment | Update a workflow name or comment by its ID |
| download_workflow_package_file | Download a workflow package file by its ID and save it to the local directory |
| get_workflow_xml | Get the XML representation of a workflow file by its ID |
| get_workflow_tool_list | Get the list of tools in a workflow by the workflow ID |
| transfer_workflow | Transfer workflow ownership to a new user |
| get_workflow_jobs | Get all jobs associated with a workflow |
| start_workflow_execution | Start a workflow execution by its ID and return the job ID. This will create a new job and add it to the execution queue. This call will return a job ID that can be used to get the job details later. The input data is a list of name-value pairs, each containing a name and value. |
| execute_workflow_with_monitoring | Execute a workflow by its ID and monitor its execution status. This call will return a jobID, he Job status and the job details once the execution is completed or failed. The input data parameter is a list of name-value pairs, each containing a name and value. |
| get_all_users | Get the list of all users of the Alteryx server |
| get_user_by_id | Get a user by their ID |
| get_user_by_email | Get a user by their email |
| get_user_by_name | Get a user by their last name |
| get_user_by_first_name | Get a user by their first name |
| get_all_user_assets | Get all the assets for a user |
| get_user_assets_by_type | Get user assets by type |
| update_user_details | Update details of an existing user by their ID |
| transfer_all_assets | Transfer all assets from one user to another |
| deactivate_user | Deactivate a user account |
| reset_user_password | Reset a user's password by their ID |
| get_all_job_messages | Get all the messages for a job |
| get_job_by_id | Retrieve details about an existing job and its current state |
| get_job_output_data | Get the output data generated by a job. This will return a list of file paths to the output data. The output data is stored in the temp directory of the server. |
| get_all_schedules | Get the list of all schedules of the Alteryx server |
| get_schedule_by_id | Get a schedule by its ID |
| deactivate_schedule | Deactivate a schedule by its ID |
| activate_schedule | Activate a schedule by its ID |
| update_schedule_name_or_comment | Update a schedule name or comment by its ID |
| change_schedule_owner | Change the owner of a schedule by its ID |
| get_all_credentials | Get the list of all accessible credentials of the Alteryx server |
| get_credential_by_id | Get the details of an existing credential |
| lookup_connection | Lookup a DCM Connection as referenced in workflows |
| get_connection_by_id | Get a connection by its ID |