Skip to main content

ReadMe

Manage ReadMe documentation, guides, changelogs, categories, and API references.

Categories: Documentation, Developer Tools

What you can ask​

  • List API reference pages last edited over 90 days ago for review.
  • Search the docs for pages mentioning legacy-auth after the migration.
  • Find docs with broken links across all sections.

Set up​

ReadMe connects with credentials from your ReadMe account. Have these values ready:

  • API key
  1. Go to Organization > Connectors and find ReadMe.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

ReadMe offers 42 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (20)​

View and search information without changing it.

ToolWhat it does
get_api_definitionGet an API definition by filename.
get_branchGet details of a specific branch (version) by name or version number.
get_categoryGet a specific category by section and title.
get_changelogGet a changelog entry by slug or ID.
get_custom_pageGet a custom page by slug.
get_guideGet a guide page by slug.
get_imageGet an uploaded image by ID.
get_projectGet ReadMe project metadata including name, subdomain, plan, and configuration.
get_recipeGet a recipe by slug.
get_reference_pageGet an API reference page by slug.
list_api_definitionsList all API definitions (OpenAPI specs) in a branch.
list_branchesList all branches (versions) in the ReadMe project.
list_categoriesList categories in a branch by section type (guides or reference).
list_category_pagesList all pages within a category.
list_changelogsList changelog entries with pagination.
list_custom_pagesList all custom pages in a branch.
list_imagesList uploaded images with pagination.
list_recipesList all recipes (tutorials) in a branch.
search_docsSearch across all documentation pages, guides, changelogs, and references.
validate_credentialValidate ReadMe credentials.

Write (7)​

Create or send data.

ToolWhat it does
create_branchCreate a new branch (version) in the ReadMe project.
create_categoryCreate a new category in a branch.
create_changelogCreate a new changelog entry.
create_custom_pageCreate a new custom page.
create_guideCreate a new guide page.
create_recipeCreate a new recipe (tutorial).
create_reference_pageCreate a new API reference page.

Delete or overwrite (15)​

Remove or replace existing data.

ToolWhat it does
delete_api_definitionDelete an API definition permanently.
delete_branchDelete a branch (version) permanently.
delete_categoryDelete a category permanently.
delete_changelogDelete a changelog entry permanently.
delete_custom_pageDelete a custom page permanently.
delete_guideDelete a guide page permanently.
delete_recipeDelete a recipe permanently.
delete_reference_pageDelete an API reference page permanently.
update_branchUpdate a branch's title.
update_categoryUpdate a category's title or position.
update_changelogUpdate a changelog entry's title, type, body, or visibility.
update_custom_pageUpdate a custom page's title, content, or visibility.
update_guideUpdate a guide page's title, body, state, or visibility.
update_recipeUpdate a recipe's title, body, excerpt, or visibility.
update_reference_pageUpdate an API reference page's title, body, state, or visibility.
⌘J