Download PDFMarkdown Version
ClaudeChatGPTPerplexityGeminiMicrosoft CopilotRaycastMeta AIGrokZ.aiQwenKimi
DeepSeekMistralCursorVS CodeWindsurfJetBrainsClineLovableVercel AI SDKLangChain

Use ReadMe with your AI.

Connect your account once and let the AI you already use work with it, without building another integration. Equip your AI to directly search, read, and manage developer documentation stored in your ReadMe project.

Included with plan

Ask AI about this Connector

Developed, maintained, and hosted by Vinkius.

MCP VERIFIED · PRODUCTION READY · VINKIUS GUARANTEED

Waiting for input…

Works with modern AI clients that support MCP, including ChatGPT, Claude, Cursor, and more.

ChatGPTClaudeCursorPerplexityGeminiMicrosoft CopilotRaycastMeta AI

Complete set · 10 capabilities

The complete ReadMe capability set.

These are the exact actions your AI can choose when you ask it to work with ReadMe.

Capability set01 / 03

01-04

4 capabilities in this set.

Part of 10 available through ReadMe.

  1. 01

    Get category

    Retrieves details for a specific documentation category

  2. 02

    List categories

    Lists all documentation categories on ReadMe

  3. 03

    Get doc

    Retrieves the full content of a documentation page

  4. 04

    List custom pages

    Lists all custom standalone pages

Capability set02 / 03

05-07

3 capabilities in this set.

Part of 10 available through ReadMe.

  1. 05

    Get project

    Retrieves details about the ReadMe project

  2. 06

    List changelogs

    Lists all changelog posts

  3. 07

    Get category docs

    Lists all documentation pages under a specific category

Capability set03 / 03

08-10

3 capabilities in this set.

Part of 10 available through ReadMe.

  1. 08

    Get changelog

    Retrieves the full content of a specific changelog post

  2. 09

    Get custom page

    Retrieves the full content of a custom page

  3. 10

    Search docs

    Performs a full-text search across all documentation pages

Observed, not estimated

869ms average. Fast in production.

ReadMe is checked daily against the live service.

Daily averagePeak 988ms
Aug 20Today
Fastest day
698ms
Slowest day
988ms
14-day trend
Stable+3%

Connect your client

One URL. Every client.

Activate the Connector, copy your link, and paste it into the client you already use. 10 capabilities arrive ready to run.

Preview access · not provider authentication

The vk_preview_* token belongs to Vinkius preview infrastructure. It lets Claude discover and display the capabilities of ReadMe, so you can see the experience inside your AI.

It does not authenticate your account with ReadMe. Actions requiring credentials or live account data may not run until you activate the Connector and authorize the service.

ReadMe Connector

You're all set. Choose your MCP client and follow the setup instructions.

Connector linkhttps://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp

Claude Desktop

Follow the steps below to connect in seconds.

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — ReadMe capabilities are ready to use.
Configuration · claude_desktop_config.jsonCopy
{
  "mcpServers": {
    "readme-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp"
    }
  }
}
  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

Step-by-step instructions for each client are in the guide. How to connect

FAQ

Questions ReadMe owners ask.

  • 01

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

  • 02

    Does the server allow me to write or edit documentation?

    Currently, the MCP server 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.

  • 03

    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.

Explore

More in Developer Tools

Suggestions