303 lines
11 KiB
JSON
303 lines
11 KiB
JSON
{
|
|
"name": "AddTaskComment",
|
|
"fully_qualified_name": "ClickupApi.AddTaskComment@0.1.0",
|
|
"description": "Add a new comment to a specific task on ClickUp.\n\nThis tool allows users to add a new comment to a specified task on ClickUp. It should be called when there's a need to comment on a task, offering a way to communicate updates, feedback, or any relevant information directly related to the task in question.",
|
|
"toolkit": {
|
|
"name": "ClickupApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "specific_task_id",
|
|
"required": true,
|
|
"description": "The ID of the task to add the comment to. Required for identifying the target task.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "task_id"
|
|
},
|
|
{
|
|
"name": "comment_content",
|
|
"required": true,
|
|
"description": "The text of the comment to be added to the task. It should contain any updates, feedback, or relevant information.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "comment_text"
|
|
},
|
|
{
|
|
"name": "send_notifications_to_all",
|
|
"required": true,
|
|
"description": "If true, notifications will be sent to everyone, including the creator of the comment.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "notify_all"
|
|
},
|
|
{
|
|
"name": "workspace_id_for_custom_task",
|
|
"required": false,
|
|
"description": "Provide the Workspace ID when referencing a task by its custom task ID (set `custom_task_ids` to true).",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "team_id"
|
|
},
|
|
{
|
|
"name": "comment_assignee_id",
|
|
"required": false,
|
|
"description": "An integer representing the user ID of the assignee for the comment on the task.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "assignee"
|
|
},
|
|
{
|
|
"name": "assignee_group",
|
|
"required": false,
|
|
"description": "Specifies a group of users (as a comma-separated string) to be assigned to the comment. Ensure the group is relevant to the task.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "group_assignee"
|
|
},
|
|
{
|
|
"name": "use_custom_task_ids",
|
|
"required": false,
|
|
"description": "Set to true to reference a task by its custom task ID.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "If you want to reference a task by it's custom task id, this value must be `true`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "custom_task_ids"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'CreateTaskComment'.",
|
|
"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-clickup",
|
|
"provider_type": "oauth2",
|
|
"id": null,
|
|
"oauth2": null
|
|
},
|
|
"secrets": null,
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the clickup API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://api.clickup.com/api/v2/task/{task_id}/comment",
|
|
"http_method": "POST",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "custom_task_ids",
|
|
"tool_parameter_name": "use_custom_task_ids",
|
|
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "If you want to reference a task by it's custom task id, this value must be `true`."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "team_id",
|
|
"tool_parameter_name": "workspace_id_for_custom_task",
|
|
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "task_id",
|
|
"tool_parameter_name": "specific_task_id",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "comment_text",
|
|
"tool_parameter_name": "comment_content",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "assignee",
|
|
"tool_parameter_name": "comment_assignee_id",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "group_assignee",
|
|
"tool_parameter_name": "assignee_group",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "notify_all",
|
|
"tool_parameter_name": "send_notifications_to_all",
|
|
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"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
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTaskCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"notify_all\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"group_assignee\": {\n \"type\": \"string\",\n \"contentEncoding\": \"int32\",\n \"description\": \"\"\n },\n \"notify_all\": {\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"d01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|