arcade-mcp/toolkits/freshservice_api/arcade_freshservice_api/wrapper_tools/GetFreshserviceAnnouncements.json

{
  "name": "GetFreshserviceAnnouncements",
  "fully_qualified_name": "FreshserviceApi.GetFreshserviceAnnouncements@0.1.0",
  "description": "Retrieve all announcements from Freshservice.\n\nUse this tool to get a list of all announcements available in Freshservice. It should be called when you need to display or review information about current announcements.",
  "toolkit": {
    "name": "ArcadeFreshserviceApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "announcement_state",
        "required": false,
        "description": "Specify the state of the announcements to retrieve: archived, active, scheduled, or unread.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "(archived, active, scheduled, unread)"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "state"
      },
      {
        "name": "announcements_per_page",
        "required": false,
        "description": "Specify the number of announcements to retrieve per page for pagination.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The number of Announcements to retrieve in each page of a paginated list."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "per_page"
      },
      {
        "name": "retrieve_page_number",
        "required": false,
        "description": "Specify the page number of announcements to retrieve. Useful for navigating through paginated results.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The page number to retrieve."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "page"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'list-announcement'.",
    "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_API_KEY"
      },
      {
        "key": "FRESHSERVICE_SUBDOMAIN"
      }
    ],
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.0.0",
    "description": "Tools that enable LLMs to interact directly with the Freshservice API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.1.0",
      "description": ""
    },
    "url": "https://{freshservice_subdomain}.freshservice.com/api/v2/announcements",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "state",
        "tool_parameter_name": "announcement_state",
        "description": "(archived, active, scheduled, unread)",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "(archived, active, scheduled, unread)"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "per_page",
        "tool_parameter_name": "announcements_per_page",
        "description": "The number of Announcements to retrieve in each page of a paginated list.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The number of Announcements to retrieve in each page of a paginated list."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": 30,
        "documentation_urls": []
      },
      {
        "name": "page",
        "tool_parameter_name": "retrieve_page_number",
        "description": "The page number to retrieve.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The page number to retrieve."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": 1,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "FRESHSERVICE_API_KEY",
        "parameter_name": "username",
        "accepted_as": "basic_auth_username",
        "formatted_value": null,
        "description": "",
        "is_auth_token": false
      },
      {
        "arcade_key": "FRESHSERVICE_SUBDOMAIN",
        "parameter_name": "freshservice_subdomain",
        "accepted_as": "path",
        "formatted_value": null,
        "description": "",
        "is_auth_token": false
      }
    ]
  }
}