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/CreateFreshserviceReleaseNote.json

346 lines
13 KiB
JSON
Raw Blame History

{
"name": "CreateFreshserviceReleaseNote",
"fully_qualified_name": "FreshserviceApi.CreateFreshserviceReleaseNote@1.0.0",
"description": "Create a new release note in Freshservice.\n\nUse this tool to add a new note to a specific release in Freshservice. It is helpful for documenting changes or updates related to a release.",
"toolkit": {
"name": "ArcadeFreshserviceApi",
"description": null,
"version": "1.0.0"
},
"input": {
"parameters": [
{
"name": "release_id",
"required": true,
"description": "The numeric ID of the specific release for which the note is to be created.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of release for which notes are to be retrieved"
},
"inferrable": true,
"http_endpoint_parameter_name": "release_id"
},
{
"name": "note_unique_id",
"required": false,
"description": "Unique integer ID of the note to be created in Freshservice.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the note"
},
"inferrable": true,
"http_endpoint_parameter_name": "id"
},
{
"name": "creator_user_id",
"required": false,
"description": "Unique integer ID of the user who created the note in Freshservice.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the user who created the note"
},
"inferrable": true,
"http_endpoint_parameter_name": "user_id"
},
{
"name": "notification_email_addresses",
"required": false,
"description": "Email addresses to notify about the release note. Provide a list of email strings.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Addresses to which the note must be notified to"
},
"inferrable": true,
"http_endpoint_parameter_name": "notify_emails"
},
{
"name": "note_body_html",
"required": false,
"description": "The content of the release note in HTML format. Use valid HTML tags for formatting.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in HTML format"
},
"inferrable": true,
"http_endpoint_parameter_name": "body"
},
{
"name": "note_body_plain_text",
"required": false,
"description": "The body content of the release note in plain text format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in plain text format"
},
"inferrable": true,
"http_endpoint_parameter_name": "body_text"
},
{
"name": "note_creation_datetime",
"required": false,
"description": "The date and time when the release note was created. Expected format is ISO 8601 (e.g., YYYY-MM-DDTHH:MM:SSZ).",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was created"
},
"inferrable": true,
"http_endpoint_parameter_name": "created_at"
},
{
"name": "note_updated_datetime",
"required": false,
"description": "The date and time when the note was last updated, in ISO 8601 format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was updated"
},
"inferrable": true,
"http_endpoint_parameter_name": "updated_at"
}
]
},
"output": {
"description": "Response from the API endpoint 'create-release-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/releases/{release_id}/notes",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "release_id",
"tool_parameter_name": "release_id",
"description": "ID of release for which notes are to be retrieved",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of release for which notes are to be retrieved"
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "id",
"tool_parameter_name": "note_unique_id",
"description": "Unique ID of the note",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the note"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "user_id",
"tool_parameter_name": "creator_user_id",
"description": "Unique ID of the user who created the note",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the user who created the note"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "notify_emails",
"tool_parameter_name": "notification_email_addresses",
"description": "Addresses to which the note must be notified to",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Addresses to which the note must be notified to"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "body",
"tool_parameter_name": "note_body_html",
"description": "The body of the note in HTML format",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in HTML format"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "body_text",
"tool_parameter_name": "note_body_plain_text",
"description": "The body of the note in plain text format",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The body of the note in plain text format"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "created_at",
"tool_parameter_name": "note_creation_datetime",
"description": "Date time at which the note was created",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was created"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "updated_at",
"tool_parameter_name": "note_updated_datetime",
"description": "Date time at which the note was updated",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the note was updated"
},
"accepted_as": "body",
"required": false,
"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\": \"Note content of release\",\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\": 14000345353\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\": 140004534\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>Assigned to IT team</p>\"\n },\n \"body_text\": {\n \"type\": \"string\",\n \"description\": \"The body of the note in plain text format\",\n \"example\": \"Assigned to IT team\"\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 }\n }\n }\n },\n \"required\": true\n}",
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}
Reference in a new issue View git blame Copy permalink