arcade-mcp/toolkits/pagerduty_api/arcade_pagerduty_api/wrapper_tools/GetAllTemplates.json
jottakka 8b4d6b773b
[MOAR][PAGERDUTY] Adding PagerDuty Tools (#609)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-13 15:10:26 -03:00

281 lines
9.9 KiB
JSON

{
"name": "GetAllTemplates",
"fully_qualified_name": "PagerdutyApi.GetAllTemplates@0.1.0",
"description": "Retrieve all templates from a Pagerduty account.\n\nThis tool retrieves a list of all the templates available in a Pagerduty account. It should be called when you need to access or manage template information in the account. Scoped OAuth with `templates.read` is required.",
"toolkit": {
"name": "ArcadePagerdutyApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "results_per_page",
"required": false,
"description": "The number of results to return per page. Use to control pagination.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The number of results per page."
},
"inferrable": true,
"http_endpoint_parameter_name": "limit"
},
{
"name": "pagination_offset",
"required": false,
"description": "Offset index to start pagination in search results. This is used to navigate through paginated results efficiently.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Offset to start pagination search results."
},
"inferrable": true,
"http_endpoint_parameter_name": "offset"
},
{
"name": "template_search_query",
"required": false,
"description": "Template name or description to search within the account's templates.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Template name or description to search"
},
"inferrable": true,
"http_endpoint_parameter_name": "query"
},
{
"name": "filter_by_template_type",
"required": false,
"description": "Filters the templates by their type. Provide the type of template you want to retrieve.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filters templates by type."
},
"inferrable": true,
"http_endpoint_parameter_name": "template_type"
},
{
"name": "sort_templates_by",
"required": false,
"description": "Specifies the field and direction to sort results, such as 'name' or 'created_at'. Defaults to ascending order if not specified.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"name",
"name:asc",
"name:desc",
"created_at",
"created_at:asc",
"created_at:desc"
],
"properties": null,
"inner_properties": null,
"description": "Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending."
},
"inferrable": true,
"http_endpoint_parameter_name": "sort_by"
},
{
"name": "include_total_in_pagination",
"required": false,
"description": "Set to true to include the total field in pagination responses for detailed counts.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated.\n\nSee our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.\n"
},
"inferrable": true,
"http_endpoint_parameter_name": "total"
}
]
},
"output": {
"description": "Response from the API endpoint 'getTemplates'.",
"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/templates",
"http_method": "GET",
"headers": {},
"parameters": [
{
"name": "limit",
"tool_parameter_name": "results_per_page",
"description": "The number of results per page.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The number of results per page."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "offset",
"tool_parameter_name": "pagination_offset",
"description": "Offset to start pagination search results.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Offset to start pagination search results."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "total",
"tool_parameter_name": "include_total_in_pagination",
"description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated.\n\nSee our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.\n",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated.\n\nSee our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.\n"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "query",
"tool_parameter_name": "template_search_query",
"description": "Template name or description to search",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Template name or description to search"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "template_type",
"tool_parameter_name": "filter_by_template_type",
"description": "Filters templates by type.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filters templates by type."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "sort_by",
"tool_parameter_name": "sort_templates_by",
"description": "Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"name",
"name:asc",
"name:desc",
"created_at",
"created_at:asc",
"created_at:desc"
],
"properties": null,
"inner_properties": null,
"description": "Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending."
},
"accepted_as": "query",
"required": false,
"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
}
]
}
}