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

Read the Docs (BYOK) — connector documentation

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

What Read the Docs (BYOK) is for

Read the Docs (BYOK) lets an AI assistant read your own Read the Docs data through the Read the Docs API with a key you supply (Read the Docs API token). Read-only: 8 tools (list_projects, get_project, list_versions, get_version, list_builds, get_build, list_subprojects, list_redirects). 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 app.readthedocs.org. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Read the Docs. Read the 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:

  • "Which documentation projects do I host on Read the Docs?"
  • "What repository and default version does the pip docs project use?"
  • "Which versions of the pip docs are active and built?"
  • "Is the latest version of the pip docs built and where is it hosted?"
  • "Did the latest documentation build of my project succeed?"
  • "Why did Read the Docs build 8592686 of pip fail?"

What it does

  • list_projects: List the documentation projects of the token's account (Read the Docs Community) with language, repository, default version and docs URL.
  • get_project: Get one Read the Docs project: repository, default version and branch, languages, tags, privacy level and docs URLs.
  • list_versions: List the documentation versions of a project with whether each is built and active, its type (branch or tag) and docs URL.
  • get_version: Get one documentation version of a project: commit identifier, build and active flags, privacy level and download links.
  • list_builds: List recent documentation builds of a project with version, state, success flag, duration, commit and error message.
  • get_build: Get one documentation build by its numeric ID: state, success, duration, commit and error text.
  • list_subprojects: List the subprojects nested under a project, with each alias and the child project slug.
  • list_redirects: List the URL redirects configured for a project: source and target paths, type, HTTP status and whether each is enabled.

BYOK key

You bring your own Read the Docs Read the Docs API token (https://app.readthedocs.org/accounts/tokens/). 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 app.readthedocs.org 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 Read the Docs API (app.readthedocs.org) with a BYOK key; documentation: https://docs.readthedocs.com/platform/stable/api/v3.html. 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 Read the Docs. Read the 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 Read the Docs account.

Built for: Worldwide. Languages: English.