arcade-mcp/toolkits/pagerduty_api/arcade_pagerduty_api/wrapper_tools/GetCustomFieldOptionDetails.json

{
  "name": "GetCustomFieldOptionDetails",
  "fully_qualified_name": "PagerdutyApi.GetCustomFieldOptionDetails@0.1.0",
  "description": "Retrieve details of a specific custom field option for an incident type.\n\nUse this tool to get information about a specific field option in a custom field, which provides additional context to incidents in Pagerduty. Useful for customized filtering, search, and analytics. Requires `custom_fields.read` OAuth scope.",
  "toolkit": {
    "name": "ArcadePagerdutyApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "incident_type_identifier",
        "required": true,
        "description": "The ID or name of the Incident Type for which you want to retrieve the custom field option details.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID or name of the Incident Type."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "type_id_or_name"
      },
      {
        "name": "field_option_id",
        "required": true,
        "description": "The unique ID of the field option to retrieve details for.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the field option."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "field_option_id"
      },
      {
        "name": "field_identifier",
        "required": true,
        "description": "The unique ID of the custom field for the incident type.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the field."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "field_id"
      },
      {
        "name": "accept_version_header",
        "required": true,
        "description": "Specify the version of the API to use by setting the `Accept` header.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The `Accept` header is used as a versioning header."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "Accept"
      },
      {
        "name": "content_type",
        "required": true,
        "description": "Specifies the media type of the request. Usually set to 'application/json'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "application/json"
          ],
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "Content-Type"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'getIncidentTypeCustomFieldFieldOptions'.",
    "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-pagerduty",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": null
    },
    "secrets": null,
    "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 Pagerduty API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.0.0",
      "description": ""
    },
    "url": "https://api.pagerduty.com/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "type_id_or_name",
        "tool_parameter_name": "incident_type_identifier",
        "description": "The ID or name of the Incident Type.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID or name of the Incident Type."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "field_option_id",
        "tool_parameter_name": "field_option_id",
        "description": "The ID of the field option.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the field option."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "field_id",
        "tool_parameter_name": "field_identifier",
        "description": "The ID of the field.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the field."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "Accept",
        "tool_parameter_name": "accept_version_header",
        "description": "The `Accept` header is used as a versioning header.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The `Accept` header is used as a versioning header."
        },
        "accepted_as": "header",
        "required": true,
        "deprecated": false,
        "default": "application/vnd.pagerduty+json;version=2",
        "documentation_urls": []
      },
      {
        "name": "Content-Type",
        "tool_parameter_name": "content_type",
        "description": "",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "application/json"
          ],
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "accepted_as": "header",
        "required": true,
        "deprecated": false,
        "default": "application/json",
        "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
      }
    ]
  }
}