> This page is for Workforce.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# ReadMe

**Authentication:** API key. See [Magic Link](/merge-agent-handler/features/magic-link) for the runtime auth flow.

## Sample use cases

* 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.

## Available Tools

#### list_api_definitions

List all API definitions (OpenAPI specs) in a branch. Returns filenames, types, and upload status.

#### get_api_definition

Get an API definition by filename. Use list_api_definitions to find available filenames.

#### delete_api_definition

Delete an API definition permanently. Use list_api_definitions to find filenames.

#### list_branches

List all branches (versions) in the ReadMe project. Returns branch names and metadata.

#### create_branch

Create a new branch (version) in the ReadMe project. Requires a name (semver). Optionally fork from an existing versi...

#### get_branch

Get details of a specific branch (version) by name or version number. Use list_branches to find available branches.

#### update_branch

Update a branch's title. Use list_branches to find available branch names.

#### delete_branch

Delete a branch (version) permanently. Cannot delete the stable branch. Use list_branches to find branch names.

#### list_categories

List categories in a branch by section type (guides or reference). Use branch='stable' for the default version.

#### create_category

Create a new category in a branch. Requires a title. Section defaults to 'guide'. Use list_categories to see existing...

#### get_category

Get a specific category by section and title. Use list_categories to find available category titles.

#### update_category

Update a category's title or position. Use list_categories to find category titles.

#### delete_category

Delete a category permanently. Use list_categories to find category titles.

#### list_category_pages

List all pages within a category. Use list_categories to find section and title values.

#### list_changelogs

List changelog entries with pagination. Supports filtering by visibility. Use page and per_page for pagination.

#### create_changelog

Create a new changelog entry. Requires a title. Optionally set type (added, fixed, improved, etc.) and body content.

#### get_changelog

Get a changelog entry by slug or ID. Use list_changelogs to find available slugs.

#### update_changelog

Update a changelog entry's title, type, body, or visibility. Use list_changelogs to find slugs.

#### delete_changelog

Delete a changelog entry permanently. Use list_changelogs to find slugs.

#### list_custom_pages

List all custom pages in a branch. Custom pages are standalone pages outside the guides/reference sections.

#### create_custom_page

Create a new custom page. Requires a title. Supports markdown or HTML content.

#### get_custom_page

Get a custom page by slug. Use list_custom_pages to find available slugs.

#### update_custom_page

Update a custom page's title, content, or visibility. Use list_custom_pages to find slugs.

#### delete_custom_page

Delete a custom page permanently. Use list_custom_pages to find slugs.

#### create_guide

Create a new guide page. Requires title and category_uri. Use list_categories with section='guides' to find category ...

#### get_guide

Get a guide page by slug. Use list_category_pages to find guide slugs.

#### update_guide

Update a guide page's title, body, state, or visibility. Use list_category_pages to find guide slugs.

#### delete_guide

Delete a guide page permanently. Use list_category_pages to find guide slugs.

#### list_images

List uploaded images with pagination. Use page and per_page for pagination (max 100 per page).

#### get_image

Get an uploaded image by ID. Use list_images to find available image IDs.

#### get_project

Get ReadMe project metadata including name, subdomain, plan, and configuration. Useful for discovering project settings.

#### list_recipes

List all recipes (tutorials) in a branch. Recipes are step-by-step guides for common tasks.

#### create_recipe

Create a new recipe (tutorial). Requires a title. Optionally include body content and excerpt.

#### get_recipe

Get a recipe by slug. Use list_recipes to find available recipe slugs.

#### update_recipe

Update a recipe's title, body, excerpt, or visibility. Use list_recipes to find slugs.

#### delete_recipe

Delete a recipe permanently. Use list_recipes to find recipe slugs.

#### create_reference_page

Create a new API reference page. Requires title and category_uri. Use list_categories with section='reference' to fin...

#### get_reference_page

Get an API reference page by slug. Use list_category_pages with section='reference' to find page slugs.

#### update_reference_page

Update an API reference page's title, body, state, or visibility. Use list_category_pages to find page slugs.

#### delete_reference_page

Delete an API reference page permanently. Use list_category_pages to find page slugs.

#### search_docs

Search across all documentation pages, guides, changelogs, and references. Returns matching results with highlighted ...