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-authafter 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
- Go to Organization > Connectors and find ReadMe.
- Click Enable and choose which tools to allow.
- 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.
| Tool | What it does |
|---|---|
get_api_definition | Get an API definition by filename. |
get_branch | Get details of a specific branch (version) by name or version number. |
get_category | Get a specific category by section and title. |
get_changelog | Get a changelog entry by slug or ID. |
get_custom_page | Get a custom page by slug. |
get_guide | Get a guide page by slug. |
get_image | Get an uploaded image by ID. |
get_project | Get ReadMe project metadata including name, subdomain, plan, and configuration. |
get_recipe | Get a recipe by slug. |
get_reference_page | Get an API reference page by slug. |
list_api_definitions | List all API definitions (OpenAPI specs) in a branch. |
list_branches | List all branches (versions) in the ReadMe project. |
list_categories | List categories in a branch by section type (guides or reference). |
list_category_pages | List all pages within a category. |
list_changelogs | List changelog entries with pagination. |
list_custom_pages | List all custom pages in a branch. |
list_images | List uploaded images with pagination. |
list_recipes | List all recipes (tutorials) in a branch. |
search_docs | Search across all documentation pages, guides, changelogs, and references. |
validate_credential | Validate ReadMe credentials. |
Write (7)
Create or send data.
| Tool | What it does |
|---|---|
create_branch | Create a new branch (version) in the ReadMe project. |
create_category | Create a new category in a branch. |
create_changelog | Create a new changelog entry. |
create_custom_page | Create a new custom page. |
create_guide | Create a new guide page. |
create_recipe | Create a new recipe (tutorial). |
create_reference_page | Create a new API reference page. |
Delete or overwrite (15)
Remove or replace existing data.
| Tool | What it does |
|---|---|
delete_api_definition | Delete an API definition permanently. |
delete_branch | Delete a branch (version) permanently. |
delete_category | Delete a category permanently. |
delete_changelog | Delete a changelog entry permanently. |
delete_custom_page | Delete a custom page permanently. |
delete_guide | Delete a guide page permanently. |
delete_recipe | Delete a recipe permanently. |
delete_reference_page | Delete an API reference page permanently. |
update_branch | Update a branch's title. |
update_category | Update a category's title or position. |
update_changelog | Update a changelog entry's title, type, body, or visibility. |
update_custom_page | Update a custom page's title, content, or visibility. |
update_guide | Update a guide page's title, body, state, or visibility. |
update_recipe | Update a recipe's title, body, excerpt, or visibility. |
update_reference_page | Update an API reference page's title, body, state, or visibility. |