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

ReadMe (BYOK) — connector documentation

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

What ReadMe (BYOK) is for

ReadMe (BYOK) lets an AI assistant read your own ReadMe data through the ReadMe API with a key you supply (ReadMe API key). Read-only: 10 tools (get_project, list_branches, list_categories, list_category_pages, get_guide_page, list_changelogs, get_changelog, list_api_definitions, list_recipes, search_docs). 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 api.readme.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ReadMe. ReadMe 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 is the subdomain and default version of my ReadMe project?"
  • "Which versions of my ReadMe docs exist?"
  • "What categories do my ReadMe guides have?"
  • "Which pages are in the Getting started category of my ReadMe guides?"
  • "Show the text of the intro page in my ReadMe guides"
  • "What is in my ReadMe changelog?"

What it does

  • get_project: Show basic data about the ReadMe project the key belongs to: name, subdomain, description, home page, default version and dates.
  • list_branches: List the versions and branches of the project with name, state and update time. Returns versions or branches depending on the project. Only for projects on ReadMe Refactored.
  • list_categories: List the categories (sidebar headings) of a docs section in one version or branch. Only for projects on ReadMe Refactored.
  • list_category_pages: List the pages inside one category with slug, title and update time. Only for projects on ReadMe Refactored.
  • get_guide_page: Get one guides page with its title, state, excerpt and Markdown body. Only for projects on ReadMe Refactored.
  • list_changelogs: List changelog entries with title, type (added, fixed, improved, etc.), slug and dates, 100 per page at most.
  • get_changelog: Get one changelog entry with its type, author and text.
  • list_api_definitions: List the uploaded API definitions (OpenAPI, Swagger, Postman) that power the API reference with file name, type and update time. Only for projects on ReadMe Refactored.
  • list_recipes: List the recipes (step-by-step tutorials) of a version with slug, title and description. Only for projects on ReadMe Refactored.
  • search_docs: Search the project's documentation (guides, reference, recipes, custom pages, discussions, changelog) and return matching pages with an excerpt.

BYOK key

You bring your own ReadMe ReadMe API key (https://docs.readme.com/main/reference/authentication). 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 api.readme.com 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 ReadMe API (api.readme.com) with a BYOK key; documentation: https://docs.readme.com/main/reference/intro-to-the-readme-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 ReadMe. ReadMe 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 ReadMe account.

Built for: Worldwide. Languages: English.