# ReadMe MCP for AI Agents AI Agent Connect

> ReadMe MCP connects your AI agent to your documentation hub so it can search, read, and manage your guides, API references, and changelogs instantly. It turns your agent into a technical writing expert that knows your docs inside out without you having to copy-paste content into a chat window.

## Overview
- **Category:** developer-tools
- **Price:** Free
- **Endpoint:** https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/ai-agent-connect
- **Tags:** api-documentation, developer-portal, technical-writing, knowledge-base, documentation-search, developer-experience

## Description

ReadMe lets your AI agent act like a senior technical writer who has memorized every page of your developer portal. Instead of hunting through tabs or copying blocks of text to give your agent context, you can just ask it to find specific information or summarize complex API endpoints. It handles the heavy lifting of scanning your published guides, changelogs, and custom pages to give you accurate answers based on your actual source of truth. When you use this Connector through the Vinkius catalog, your agent stops guessing and starts using your official documentation as its primary reference. This means you can draft new guides that match your existing style, audit your current content for outdated links, or pull the latest product updates into a conversation without leaving your workspace. It's about moving from searching for the right page to getting the answer you need instantly.

## Tools

### list_categories
Lists all documentation categories on ReadMe. Use this to let your agent see the full structure of your portal.

### get_category
Gets details for a specific documentation category. Use this to understand how a section is organized.

### get_category_docs
Lists all documentation pages under a specific category. This helps your agent see all available guides in one section.

### get_doc
Retrieves the full content of a documentation page. This lets the agent read the exact Markdown text for a guide.

### list_custom_pages
Lists all custom standalone pages. This finds content that isn't part of your main categories.

### get_custom_page
Retrieves the full content of a custom page. This lets your agent read specific standalone content.

### get_project
Retrieves details about the ReadMe project. This gives your agent a high-level view of your documentation hub.

### search_docs
Performs a full-text search across all documentation pages. Use this for finding specific instructions quickly.

### list_changelogs
Lists all changelog posts. This provides a history of all official product updates.

### get_changelog
Retrieves the full content of a specific changelog post. Use this to get the details of a specific release.

## Prompt Examples

**Prompt:** 
```
Find the instructions for setting up webhooks in our docs.
```

**Response:** 
```
I searched the documentation and found the following guide:

### Webhook Installation
To set up webhooks, follow these steps:
1. Generate a secret key in the **Developer Dashboard**.
2. Set the **Endpoint URL** to your listener.
3. Verify the signature using the provided header.

*Source: Webhook Setup Guide*
```

**Prompt:** 
```
What was in the v2-api-release changelog?
```

**Response:** 
```
The **v2-api-release** included the following updates:

| Feature | Change | Status |
| :--- | :--- | :--- |
| Rate Limits | Increased to 1000 req/min | **Live** |
| User Management | New endpoints for bulk delete | **Live** |
| Metrics | Deprecated v1 paths | **Warning** |

*Source: Changelog - v2-api-release*
```

**Prompt:** 
```
List all the main categories in our documentation.
```

**Response:** 
```
Here are the primary categories for your documentation project:

*   **Getting Started**
*   **Authentication**
*   **REST API Reference**
*   **Webhooks Guide**
```

## Capabilities

### Search all published guides
Your agent can perform full-text searches across your entire documentation library.

### Pull specific Markdown content
The agent retrieves the exact text of any documentation page or changelog post.

### Analyze documentation structure
Your agent can see how your categories are organized to help plan new content.

### Track official changelogs
The agent pulls recent product updates and announcements directly from your project.

### Access custom standalone pages
Your agent can find and read pages that live outside your standard categories.

## Use Cases

### Auditing old guides
A writer asks the agent to find all pages in a category to check for broken links or outdated info using get_category_docs.

### Drafting new API docs
An engineer asks the agent to summarize a changelog to write a new Getting Started guide using get_changelog.

### Quick API lookups
A dev asks for the specific webhook setup instructions from the docs using search_docs.

### Content planning
A manager asks the agent to list all categories to see where new content fits best using list_categories.

## Benefits

- Stop copy-pasting Markdown into your chat. Use get_doc to let the agent pull the exact content it needs from your ReadMe project.
- Find specific technical details faster. search_docs lets your agent scan your entire guide library for specific keywords or instructions.
- Keep your content consistent. Use list_categories and get_category to help your agent understand how to structure new documentation.
- Stay updated on product changes. list_changelogs and get_changelog let your agent pull the latest release notes into a summary.
- Access standalone content easily. Use list_custom_pages and get_custom_page to retrieve specific guides that aren't part of your main categories.

## How It Works

The bottom line is your AI agent gets instant, accurate access to your official developer documentation.

1. Authorize the ReadMe MCP in your environment.
2. Provide your ReadMe API Key from your project's Configuration settings.
3. Ask your AI to summarize an API endpoint or list recent updates.

## Frequently Asked Questions

**Can the ReadMe MCP help me write better API guides?**
Yes. It helps your AI agent stay consistent with your existing style and structure by giving it direct access to your current guides.

**How does this help with changelog tracking?**
It lets your AI agent pull official updates automatically so you can summarize what changed without manual searching.

**Can my agent search specific categories?**
Yes. Your agent can list and fetch docs by category to find information in specific sections of your portal.

**Is this for my private docs?**
It works with your ReadMe project based on your personal API key, keeping your connection secure.

**Does it support custom pages?**
Yes. It can list and retrieve standalone pages that aren't part of your main documentation categories.

**How do I give the agent access?**
You just need to provide your ReadMe API key in your Connector settings to connect your project.

**Where do I obtain my ReadMe API Key?**
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).

**Does the server allow me to write or edit documentation?**
Currently, the Connector is focused on read-only operations. It can query, retrieve, and search changelogs, custom pages, and standard documentation categories, bringing context to the AI securely without risking accidental overwrites.

**In what format is the document content returned?**
All text and page content uses native Markdown format directly fetched from ReadMe's engine. This makes it perfect for the AI to interpret, syntax-highlight, and display naturally within chat or code comments.