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

ReadMe Content (BYOK) — connector documentation

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

What ReadMe Content (BYOK) is for

ReadMe Content (BYOK) lets an AI assistant read your own ReadMe Content data through the ReadMe Content API with a key you supply (ReadMe API key). Read-only: 7 tools (list_custom_pages, get_custom_page, get_reference_page, get_glossary, suggest_pages_for_missing_url, list_images, get_outbound_ips). 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 Content. ReadMe Content 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 custom pages does my ReadMe project have?"
  • "When was my ReadMe pricing page last updated?"
  • "What state is my ReadMe get-users reference page in?"
  • "Which glossary terms does my ReadMe project define?"
  • "Which ReadMe page matches the missing path /docs/old-guide?"
  • "Which images are uploaded to my ReadMe project?"

What it does

  • list_custom_pages: List the custom pages of a version with slug, title, metadata title and description, privacy and update time. Page bodies are not returned. Only for projects on ReadMe Refactored.
  • get_custom_page: Get one custom page by slug: title, metadata, privacy and update time (body left out). Only for projects on ReadMe Refactored.
  • get_reference_page: Get one API reference page by slug: title, type (endpoint, basic and so on), state, category, parent, privacy and metadata (body and API definition left out). Only for projects on ReadMe Refactored.
  • get_glossary: Export the project's glossary: each term and its definition, optionally with terms inherited from an Enterprise group.
  • suggest_pages_for_missing_url: Suggest existing pages similar to a missing documentation path (useful for broken links); returns title and relative URL of each suggestion.
  • list_images: List images uploaded to the project with name, size and address.
  • get_outbound_ips: List the IP addresses ReadMe uses for outbound requests (for firewall allow lists).

BYOK key

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

Built for: Worldwide. Languages: English.