Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Help Scout Docs (BYOK) — connector documentation

  • MCP endpoint: https://byok-helpscout.connectorbay.com/mcp
  • REST API: POST https://byok-helpscout.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-helpscout.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Help Scout Docs Docs API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-helpscout.connectorbay.com/health · Tool schemas: https://byok-helpscout.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-helpscout · agent@connectorbay.com

What Help Scout Docs (BYOK) is for

Help Scout Docs (BYOK) lets an AI assistant read your own Help Scout Docs data through the Help Scout Docs API with a key you supply (Docs API key). Read-only: 6 tools (list_collections, list_categories, list_collection_articles, list_category_articles, search_articles, get_article). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to docsapi.helpscout.net. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Help Scout Docs. Help Scout Docs and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "What collections does my Help Scout knowledge base have?"
  • "What categories are in my Help Scout 'Getting started' collection?"
  • "Which articles are published in my Help Scout 'Getting started' collection?"
  • "Which articles are in my Help Scout 'Accounts' category?"
  • "Search my Help Scout docs for articles about resetting a password"
  • "Show me Help Scout article 12 in full"

What it does

  • list_collections: List your Docs collections (groups of articles) with visibility, article counts and public URL. Use the ids with the other tools.
  • list_categories: List the categories inside one Docs collection with article counts.
  • list_collection_articles: List the articles of one collection (name, number, status, public URL, view count, dates) without their body text.
  • list_category_articles: List the articles of one category (name, number, status, public URL, view count, dates) without their body text.
  • search_articles: Search Docs articles by text; returns matching articles with a short preview, URL, status and visibility.
  • get_article: Get one article with its full body text (HTML), collection, categories, related articles, view count and dates.

BYOK key

You bring your own Help Scout Docs Docs API key (https://developer.helpscout.com/docs-api/). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to docsapi.helpscout.net over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Help Scout Docs API (docsapi.helpscout.net) with a BYOK key; documentation: https://developer.helpscout.com/docs-api/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Help Scout Docs. Help Scout Docs and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Help Scout Docs account.

Built for: Worldwide. Languages: English.