ReadMe

ReadMe MCP Connector for Claude

A+

Equip your AI to directly search, read, and manage developer documentation stored in your ReadMe project.

10 tools Official Updated Jun 28, 2026 Official Vinkius Partner

Connect your ReadMe documentation hub directly to your AI agent. Enabling this integration turns your AI into an expert technical writer and reader, capable of instantly scanning your entire developer documentation, changelogs, and custom pages without context switching.

What you can do

  • Documentation Search — Perform full-text searches across all your published guides and API references.
  • Content Retrieval — Fetch the exact Markdown content of any specific documentation page, changelog, or category.
  • Project Analysis — Understand how your documentation is categorized and structure new content accordingly.
  • Changelog Tracking — Pull recent product updates and announcements formally published to your users.

How it works

  1. Authorize the ReadMe MCP server in your environment.
  2. Provide your ReadMe API Key (found under your project's Configuration settings).
  3. Ask your AI to summarize a specific API endpoint's documentation or list recent changelogs directly from your chat.

Who is this for?

  • Developer Advocates — Verify the accuracy of published guides and quickly draft new content referencing existing structures.
  • Technical Writers — Search and audit current documentation for outdated references without leaving your code editor.
  • Software Engineers — Instantly pull your company's official API documentation into your IDE to ensure your code aligns with published standards.
api-documentationdeveloper-portaltechnical-writingknowledge-basedocumentation-searchdeveloper-experience

10 tools expose this connector's capabilities to your AI agent.

list_categories

Lists all documentation categories on ReadMe

get_category

Retrieves details for a specific documentation category

get_category_docs

Lists all documentation pages under a specific category

get_doc

Retrieves the full content of a documentation page

search_docs

Performs a full-text search across all documentation pages

list_changelogs

Lists all changelog posts

get_changelog

Retrieves the full content of a specific changelog post

list_custom_pages

Lists all custom standalone pages

get_custom_page

Retrieves the full content of a custom page

get_project

Retrieves details about the ReadMe project

See how to talk to your AI agent using ReadMe.

Search the documentation for instructions on configuring webhooks.

Using the `search_docs` tool, I found several results. The top match is 'Webhook Installation Guide' (Slug: webhook-setup). It provides step-by-step instructions on setting endpoint URLs.

Get the contents of the changelog titled 'v2-api-release'.

I requested `get_changelog` for 'v2-api-release'. The post details new rate limits, updated endpoints for user management, and deprecation notices for the v1 metrics paths.

List all main documentation categories.

I fetched the configuration using `list_categories`. There are 4 global categories: 'Getting Started', 'Authentication', 'REST API Reference', and 'Webhooks Guide'.

Log into your ReadMe dashboard. Navigate to your specific project, then open 'Configuration' and click on 'API Key'. You will use this key as the authentication parameter (our integration handles it natively as a Basic Auth username).

Related Connectors