admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/freshservice_api/arcade_freshservice_api/wrapper_tools/AddTicketNote.json

392 lines
17 KiB
JSON
Raw Blame History

{
"name": "AddTicketNote",
"fully_qualified_name": "FreshserviceApi.AddTicketNote@1.0.0",
"description": "Add a new note to a Freshservice ticket.\n\nUse this tool to post a new note on a specific Freshservice ticket by providing the ticket ID. This is useful for updating ticket information, providing status updates, or adding additional details related to the ticket.",
"toolkit": {
"name": "ArcadeFreshserviceApi",
"description": null,
"version": "1.0.0"
},
"input": {
"parameters": [
{
"name": "ticket_id_to_add_note",
"required": true,
"description": "The ID of the Freshservice ticket to which the note will be added. This ID is required to specify the particular ticket to update.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of the ticket for which note has to be added"
},
"inferrable": true,
"http_endpoint_parameter_name": "ticket_id"
},
{
"name": "note_details",
"required": true,
"description": "Details of the note to be posted, including user ID, privacy settings, body content, and attachments.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the note"
},
"user_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the user who created the note"
},
"private": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Set to true if the note is private. The default value is true."
},
"incoming": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Set to true if the note should appear as being created from the outside (i.e., not through the web portal)"
},
"notify_emails": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Addresses to which the note must be notified to"
},
"body": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in HTML format"
},
"body_text": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in plain text format"
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was created"
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was updated"
},
"attachments": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Auto increment value"
},
"content_type": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"size": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Size of the attached file"
},
"name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Name of the attachment"
},
"attachment_url": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "URL of the attachment"
}
},
"description": null
}
},
"inner_properties": null,
"description": "details of the note to be posted"
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
}
]
},
"output": {
"description": "Response from the API endpoint 'create-ticket-note'.",
"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": null,
"secrets": [
{
"key": "FRESHSERVICE_SUBDOMAIN"
},
{
"key": "FRESHSERVICE_API_KEY"
}
],
"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 Freshservice API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://{freshservice_subdomain}.freshservice.com/api/v2/tickets/{ticket_id}/notes",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "ticket_id",
"tool_parameter_name": "ticket_id_to_add_note",
"description": "ID of the ticket for which note has to be added",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of the ticket for which note has to be added"
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "requestBody",
"tool_parameter_name": "note_details",
"description": "details of the note to be posted",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the note"
},
"user_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the user who created the note"
},
"private": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Set to true if the note is private. The default value is true."
},
"incoming": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Set to true if the note should appear as being created from the outside (i.e., not through the web portal)"
},
"notify_emails": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Addresses to which the note must be notified to"
},
"body": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in HTML format"
},
"body_text": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in plain text format"
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was created"
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was updated"
},
"attachments": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Auto increment value"
},
"content_type": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"size": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Size of the attached file"
},
"name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Name of the attachment"
},
"attachment_url": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "URL of the attachment"
}
},
"description": null
}
},
"inner_properties": null,
"description": "details of the note to be posted"
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "FRESHSERVICE_SUBDOMAIN",
"parameter_name": "freshservice_subdomain",
"accepted_as": "path",
"formatted_value": null,
"description": "",
"is_auth_token": false
},
{
"arcade_key": "FRESHSERVICE_API_KEY",
"parameter_name": "username",
"accepted_as": "basic_auth_username",
"formatted_value": null,
"description": "",
"is_auth_token": false
}
],
"request_body_spec": "{\n \"description\": \"details of the note to be posted\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the note\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 14000398432\n },\n \"user_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the user who created the note\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 1400034853\n },\n \"private\": {\n \"type\": \"boolean\",\n \"description\": \"Set to true if the note is private. The default value is true.\",\n \"example\": true\n },\n \"incoming\": {\n \"type\": \"boolean\",\n \"description\": \"Set to true if the note should appear as being created from the outside (i.e., not through the web portal)\",\n \"example\": true\n },\n \"notify_emails\": {\n \"type\": \"array\",\n \"description\": \"Addresses to which the note must be notified to\",\n \"example\": [\n \"andrea@freshservice.com\",\n \"john.doe@freshservice.com\"\n ],\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"body\": {\n \"type\": \"string\",\n \"description\": \"The body of the note in HTML format\",\n \"example\": \"<p>Developers debugging the isue</p>\"\n },\n \"body_text\": {\n \"type\": \"string\",\n \"description\": \"The body of the note in plain text format\",\n \"example\": \"Developers debugging the issue\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"Date time at which the note was created\",\n \"format\": \"date_time\",\n \"readOnly\": true,\n \"example\": \"2021-11-22T16:58:45Z\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"Date time at which the note was updated\",\n \"format\": \"date_time\",\n \"readOnly\": true,\n \"example\": \"2021-11-22T16:58:45Z\"\n },\n \"attachments\": {\n \"type\": \"array\",\n \"example\": [\n {\n \"id\": 14000884384,\n \"content_type\": \"application/pdf\",\n \"size\": 1024,\n \"name\": \"doc1.pdf\",\n \"attachment_url\": \"https://s3.amazonaws.com/fs/doc1.pdf\"\n }\n ],\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Auto increment value\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 14000884384\n },\n \"content_type\": {\n \"type\": \"string\",\n \"example\": \"application/pdf\"\n },\n \"size\": {\n \"type\": \"number\",\n \"description\": \"Size of the attached file\",\n \"readOnly\": true,\n \"example\": 1024.0\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the attachment\",\n \"example\": \"doc1.pdf\"\n },\n \"attachment_url\": {\n \"type\": \"string\",\n \"description\": \"URL of the attachment\",\n \"example\": \"https://s3.amazonaws.com/fs/doc1.pdf\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"required\": true\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}
Reference in a new issue View git blame Copy permalink