admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/slack_api/arcade_slack_api/wrapper_tools/UpdateSlackUserGroup.json
Renato Byrro 25718bbf77
Slack wrapper toolkit in Python with JSON definitions (#574) 
finally!
2025-09-23 13:48:21 -03:00

365 lines
11 KiB
JSON
Raw Blame History

{
"name": "UpdateSlackUserGroup",
"fully_qualified_name": "SlackApi.UpdateSlackUserGroup@0.1.0",
"description": "Update an existing User Group in Slack.\n\nThis tool updates an existing User Group in Slack. It should be called when you need to modify the details of a user group, such as its name or permissions. Ensure the appropriate permissions are granted with the 'usergroups:write' scope.",
"toolkit": {
"name": "ArcadeSlackApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "user_group_id",
"required": true,
"description": "The encoded ID of the User Group to update in Slack.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "usergroup"
},
{
"name": "default_channel_ids",
"required": false,
"description": "A comma-separated list of channel IDs where the User Group is set as default. Use encoded channel IDs.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "channels"
},
{
"name": "additional_channel_ids",
"required": false,
"description": "Comma separated encoded channel IDs for custom additions to user group members.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "additional_channels"
},
{
"name": "user_group_description",
"required": false,
"description": "A short description of the User Group to update in Slack. This should clearly define the group's purpose or role.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "description"
},
{
"name": "user_group_handle",
"required": false,
"description": "Unique mention handle for the User Group, distinct from all channels, users, and other User Groups.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "handle"
},
{
"name": "user_group_name",
"required": false,
"description": "A unique name for the User Group to update. Ensure it does not duplicate any existing User Group names.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "name"
},
{
"name": "team_id_for_org_token",
"required": false,
"description": "Encoded team ID where the user group exists, required for org-level tokens. Ignored if using a workspace-level token.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "team_id"
},
{
"name": "include_user_count",
"required": false,
"description": "Set to true to include the number of users in the User Group.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "include_count"
},
{
"name": "enable_sidebar_section",
"required": false,
"description": "Set to true to configure the user group to appear as a sidebar section for all group members. Only relevant if the group has 1 or more default channels.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"inferrable": true,
"http_endpoint_parameter_name": "enable_section"
}
]
},
"output": {
"description": "Response from the API endpoint 'usergroups.update'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": {
"provider_id": "arcade-slack",
"provider_type": "oauth2",
"id": null,
"oauth2": {
"scopes": [
"usergroups:write"
]
}
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.0.0",
"description": "Arcade Wrapper Tools enabling LLMs to interact with low-level Slack API endpoints."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.0.0",
"description": ""
},
"url": "https://slack.com/api/usergroups.update",
"http_method": "POST",
"headers": {
"Content-Type": "application/x-www-form-urlencoded"
},
"parameters": [
{
"name": "usergroup",
"tool_parameter_name": "user_group_id",
"description": "The encoded ID of the User Group to update.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"documentation_urls": []
},
{
"name": "channels",
"tool_parameter_name": "default_channel_ids",
"description": "A comma separated string of encoded channel IDs for which the User Group uses as a default.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "additional_channels",
"tool_parameter_name": "additional_channel_ids",
"description": "A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "description",
"tool_parameter_name": "user_group_description",
"description": "A short description of the User Group.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "handle",
"tool_parameter_name": "user_group_handle",
"description": "A mention handle. Must be unique among channels, users and User Groups.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "include_count",
"tool_parameter_name": "include_user_count",
"description": "Include the number of users in the User Group.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "name",
"tool_parameter_name": "user_group_name",
"description": "A name for the User Group. Must be unique among User Groups.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "team_id",
"tool_parameter_name": "team_id_for_org_token",
"description": "Encoded team id where the user group exists, required if org token is used",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "enable_section",
"tool_parameter_name": "enable_sidebar_section",
"description": "Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"documentation_urls": []
}
],
"documentation_urls": [
"https://docs.slack.dev/reference/methods/usergroups.update"
],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
]
}
}
Reference in a new issue View git blame Copy permalink