Merge Unified's ReadMe integration Merge Agent Handler's ReadMe MCP server

Connect your AI Agents to ReadMe in minutes

Merge lets you securely connect your agents to ReadMe and thousands of tools instantly

Start building for free

Read docs

ReadMe

Learn more about Merge Agent Handler

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 listapidefinitions to find available filenames.

delete_api_definition

Delete an API definition permanently. Use listapidefinitions 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 version via base.

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

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 listcustompages to find available slugs.

update_custom_page

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

delete_custom_page

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

create_guide

Create a new guide page. Requires title and categoryuri. Use listcategories with section='guides' to find category URIs.

get_guide

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

update_guide

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

delete_guide

Delete a guide page permanently. Use listcategorypages 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 categoryuri. Use listcategories with section='reference' to find category URIs.

get_reference_page

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

update_reference_page

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

delete_reference_page

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

search_docs

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

validate_credential

Validate ReadMe credentials. Verifies that the API key is valid by fetching project metadata.

View all tools by creating a free account See more tools

How to set up Merge Agent Handler

In an mcp.json file, add the configuration below, and restart Cursor.

Learn more in the official documentation ↗

1{
2  "mcpServers": {
3    "agent-handler": {
4      "url": "https://ah-api-develop.merge.dev/api/v1/tool-packs/{TOOL_PACK_ID}/registered-users/{REGISTERED_USER_ID}/mcp",
5      "headers": {
6        "Authorization": "Bearer yMt*****"
7      }
8    }
9  }
10}
11

Copy Code

Open your Claude Desktop configuration file and add the server configuration below. You'll also need to restart the application for the changes to take effect.

Make sure Claude is using the Node v20+.

Learn more in the official documentation ↗

1{
2  "mcpServers": {
3    "agent-handler": {
4      "command": "npx",
5      "args": [
6        "-y",
7        "mcp-remote@latest",
8        "https://ah-api-develop.merge.dev/api/v1/tool-packs/{TOOL_PACK_ID}/registered-users/{REGISTERED_USER_ID}/mcp",
9        "--header",
10        "Authorization: Bearer ${AUTH_TOKEN}"
11      ],
12      "env": {
13        "AUTH_TOKEN": "yMt*****"
14      }
15    }
16  }
17}

Copy Code

Open your Windsurf MCP configuration file and add the server configuration below.
Click on the refresh button in the top right of the Manage MCP server page or in the top right of the chat box in the box icon.

Learn more in the official documentation ↗

1{
2    "mcpServers": {
3      "agent-handler": {
4        "command": "npx",
5        "args": [
6          "-y",
7          "mcp-remote@latest",
8          "https://ah-api.merge.dev/api/v1/tool-packs/<tool-pack-id>/registered-users/<registered-user-id>/mcp",
9          "--header",
10          "Authorization: Bearer ${AUTH_TOKEN}"
11        ],
12        "env": {
13          "AUTH_TOKEN": "<ah-production-access-key>"
14        }
15      }
16    }
17  }

Copy Code

In Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows), run "MCP: Open User Configuration".

You can then add the configuration below and press "start" right under servers. Enter the auth token when prompted.

Learn more in the official documentation ↗

1{
2  "inputs": [
3    {
4      "type": "promptString",
5      "id": "agent-handler-auth",
6      "description": "Agent Handler AUTH_TOKEN", // "yMt*****" when prompt
7      "password": true
8    }
9  ],
10  "servers": {
11    "agent-handler": {
12      "type": "stdio",
13      "command": "npx",
14      "args": [
15        "-y",
16        "mcp-remote@latest",
17        "https://ah-api-develop.merge.dev/api/v1/tool-packs/{TOOL_PACK_ID}/registered-users/{REGISTERED_USER_ID}/mcp",
18        "--header",
19        "Authorization: Bearer ${input:agent-handler-auth}"
20      ]
21    }
22  }
23}