{
  "service": "helpscout_docs",
  "displayName": "Help Scout Docs",
  "categories": [
    "Productivity",
    "Communication"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "Docs API Key",
      "placeholder": "HELPSCOUT_DOCS_API_KEY",
      "description": "Help Scout Docs API key used with HTTP Basic Authentication. In Help Scout Docs, open Authentication and then the API Keys tab."
    }
  ],
  "homepageUrl": "https://www.helpscout.com",
  "actions": [
    {
      "id": "helpscout_docs.get_article",
      "service": "helpscout_docs",
      "name": "get_article",
      "description": "Get a Help Scout Docs article by ID or article number.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "articleIdOrNumber": {
            "type": "string",
            "minLength": 1,
            "description": "The Help Scout Docs article ID or article number to fetch."
          },
          "draft": {
            "type": "boolean",
            "description": "Whether to return the draft version when unpublished changes exist."
          }
        },
        "additionalProperties": false,
        "required": [
          "articleIdOrNumber"
        ],
        "description": "Input parameters for getting a Help Scout Docs article."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "article": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A Help Scout Docs article object returned by the API."
          }
        },
        "additionalProperties": false,
        "required": [
          "article"
        ],
        "description": "A Help Scout Docs article returned by the API."
      }
    },
    {
      "id": "helpscout_docs.list_articles",
      "service": "helpscout_docs",
      "name": "list_articles",
      "description": "List Help Scout Docs articles in a collection or category.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "collectionId": {
            "type": "string",
            "minLength": 1,
            "description": "The Help Scout Docs collection ID whose articles to list."
          },
          "categoryId": {
            "type": "string",
            "minLength": 1,
            "description": "The Help Scout Docs category ID whose articles to list."
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "The 1-based page number to request."
          },
          "pageSize": {
            "type": "integer",
            "minimum": 1,
            "description": "The number of items Help Scout Docs should return per page."
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for listing Help Scout Docs articles. Provide exactly one of collectionId or categoryId."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "page": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The current page number returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "pages": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total number of pages returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The number of items returned on this page."
              },
              {
                "type": "null"
              }
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A Help Scout Docs article reference object returned by the API."
            },
            "description": "The Help Scout Docs article reference objects on this page."
          }
        },
        "additionalProperties": false,
        "required": [
          "page",
          "pages",
          "count",
          "items"
        ],
        "description": "A paginated list of Help Scout Docs article reference objects."
      }
    },
    {
      "id": "helpscout_docs.list_categories",
      "service": "helpscout_docs",
      "name": "list_categories",
      "description": "List Help Scout Docs categories in a collection.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "collectionId": {
            "type": "string",
            "minLength": 1,
            "description": "The Help Scout Docs collection ID whose categories to list."
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "The 1-based page number to request."
          },
          "pageSize": {
            "type": "integer",
            "minimum": 1,
            "description": "The number of items Help Scout Docs should return per page."
          }
        },
        "additionalProperties": false,
        "required": [
          "collectionId"
        ],
        "description": "Input parameters for listing Help Scout Docs categories."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "page": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The current page number returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "pages": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total number of pages returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The number of items returned on this page."
              },
              {
                "type": "null"
              }
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A Help Scout Docs category object returned by the API."
            },
            "description": "The Help Scout Docs category objects on this page."
          }
        },
        "additionalProperties": false,
        "required": [
          "page",
          "pages",
          "count",
          "items"
        ],
        "description": "A paginated list of Help Scout Docs category objects."
      }
    },
    {
      "id": "helpscout_docs.list_collections",
      "service": "helpscout_docs",
      "name": "list_collections",
      "description": "List Help Scout Docs collections available to the API key.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "The 1-based page number to request."
          },
          "pageSize": {
            "type": "integer",
            "minimum": 1,
            "description": "The number of items Help Scout Docs should return per page."
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for listing Help Scout Docs collections."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "page": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The current page number returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "pages": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total number of pages returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The number of items returned on this page."
              },
              {
                "type": "null"
              }
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A Help Scout Docs collection object returned by the API."
            },
            "description": "The Help Scout Docs collection objects on this page."
          }
        },
        "additionalProperties": false,
        "required": [
          "page",
          "pages",
          "count",
          "items"
        ],
        "description": "A paginated list of Help Scout Docs collection objects."
      }
    },
    {
      "id": "helpscout_docs.list_sites",
      "service": "helpscout_docs",
      "name": "list_sites",
      "description": "List Help Scout Docs sites available to the API key.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "The 1-based page number to request."
          },
          "pageSize": {
            "type": "integer",
            "minimum": 1,
            "description": "The number of items Help Scout Docs should return per page."
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for listing Help Scout Docs sites."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "page": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The current page number returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "pages": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total number of pages returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The number of items returned on this page."
              },
              {
                "type": "null"
              }
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A Help Scout Docs site object returned by the API."
            },
            "description": "The Help Scout Docs site objects on this page."
          }
        },
        "additionalProperties": false,
        "required": [
          "page",
          "pages",
          "count",
          "items"
        ],
        "description": "A paginated list of Help Scout Docs site objects."
      }
    },
    {
      "id": "helpscout_docs.search_articles",
      "service": "helpscout_docs",
      "name": "search_articles",
      "description": "Search Help Scout Docs articles by query with optional collection and site filters.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "minLength": 1,
            "description": "The search query to run against Help Scout Docs articles."
          },
          "collectionId": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Help Scout Docs collection ID to filter by."
          },
          "siteId": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Help Scout Docs site ID to filter by."
          },
          "visibility": {
            "type": "string",
            "enum": [
              "public",
              "private"
            ],
            "description": "The optional collection visibility filter."
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "The 1-based page number to request."
          },
          "pageSize": {
            "type": "integer",
            "minimum": 1,
            "description": "The number of items Help Scout Docs should return per page."
          }
        },
        "additionalProperties": false,
        "required": [
          "query"
        ],
        "description": "Input parameters for searching Help Scout Docs articles."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "page": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The current page number returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "pages": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total number of pages returned by Help Scout Docs."
              },
              {
                "type": "null"
              }
            ]
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The number of items returned on this page."
              },
              {
                "type": "null"
              }
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A Help Scout Docs article search result object returned by the API."
            },
            "description": "The Help Scout Docs article search result objects on this page."
          }
        },
        "additionalProperties": false,
        "required": [
          "page",
          "pages",
          "count",
          "items"
        ],
        "description": "A paginated list of Help Scout Docs article search result objects."
      }
    }
  ]
}