ReadMe (BYOK): Read your ReadMe documentation project: pages, categories, changelog, API definitions, recipes, branches and search, with BYOK

Try asking

Real questions, and the tools your agent calls to answer them.

What is the subdomain and default version of my ReadMe project?

Tools called

get_project

Which versions of my ReadMe docs exist?

Tools called

list_branches

What categories do my ReadMe guides have?

Tools called

list_categories

Which pages are in the Getting started category of my ReadMe guides?

Tools called

list_category_pages

Show the text of the intro page in my ReadMe guides

Tools called

get_guide_page

What is in my ReadMe changelog?

Tools called

list_changelogs

About

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.

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.

Privacy

The publisher, Unify Dynamics LLC, states that tool inputs are processed in memory and not retained.

Data not collectedNo account, no profile, no stored prompts or results.

Privacy policy Terms

What it can do

10 tools, grouped by job. Every one is read-only or compute-only.

OpenAPI

Read your data10 tools

Get projectShow basic data about the ReadMe project the key belongs to: name, subdomain, description, home page, default version and dates.
List branchesList the versions and branches of the project with name, state and update time.
List categoriesList the categories (sidebar headings) of a docs section in one version or branch.
List category pagesList the pages inside one category with slug, title and update time.
Get guide pageGet one guides page with its title, state, excerpt and Markdown body.
List changelogsList changelog entries with title, type (added, fixed, improved, etc.), slug and dates, 100 per page at most.
Get changelogGet one changelog entry with its type, author and text.
List api definitionsList the uploaded API definitions (OpenAPI, Swagger, Postman) that power the API reference with file name, type and update time.
List recipesList the recipes (step-by-step tutorials) of a version with slug, title and description.
Search docsSearch the project's documentation (guides, reference, recipes, custom pages, discussions, changelog) and return matching pages with an excerpt.