How do I connect my ReadMe docs to my AI?

You connect the MCP via Vinkius and provide your ReadMe API Key, which you can find in your project's Configuration settings.

Which AI clients can use this MCP?

This MCP works with any compatible client, including Claude, Cursor, Windsurf, and VS Code.

Can the AI see my private documentation?

The AI can access any documentation that your provided ReadMe API Key has permission to view.

Does this work with API references?

Yes, the AI can search and retrieve full content from your API reference pages.

Can I use this to check for recent updates?

Yes, the MCP includes capabilities to list and retrieve the full content of your changelog posts.

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

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.

An astronaut overseeing a futuristic data hub

Download PDF Markdown Version

Connect ReadMe to ChatGPT, Claude and Gemini

Set it up once and it works in ChatGPT, Claude, Cursor, and any other client you love. It all runs safely in the background, so you can relax and focus on what really matters. Turn your AI agent into a technical documentation expert.

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.

Your AI does the work. We keep it safe and sound.

No other AI tool gives you this. Your workflow runs in the client you already love, your account stays protected, and you decide what the agent can and cannot do. It is the whole reason to make the switch.

Each Connector lives inside our infrastructure, the same place where your workflow runs. The three things below are already part of it, working quietly in the background so you never have to think about them. Nothing to add, nothing to set up, nothing to worry about.

V8 Isolate01

Each Connector runs inside its own sealed environment.

Each Connector runs inside its own sealed V8 runtime — no access to your files, your system, or other servers. A Connector never sees past its own request.

Kill Switch02

One switch stops every agent. Instantly.

One action deactivates every Connector, revokes every token, and ends every session at once. AI Governance keeps the record.

FinOps per User03

Spending limits that pause instead of surprise.

Every user keeps their own connections and credentials, isolated from everyone else. Anything that would cross your spending limit is held for your approval, not billed.

Three controls, built into the layer your AI connects through.

Curated set · 10 capabilities

We ship only the actions that matter.

Capability set01 / 03

01-04

4 capabilities in this set.

Part of 10 available through ReadMe.

01
List categories
This capability pulls a list of all documentation categories currently active in your ReadMe project.
02
Get category
Use this to grab specific details about a single documentation category.
03
List custom pages
This capability returns a list of all standalone custom pages in your project.
04
Get doc
This capability retrieves the full Markdown content for any specific documentation page.

Capability set02 / 03

05-07

3 capabilities in this set.

Part of 10 available through ReadMe.

05
Get category docs
Use this to see every documentation page nested under a specific category.
06
Get changelog
This capability fetches the complete text of a specific changelog entry.
07
Search docs
This capability performs a full-text search across your entire documentation library.

Capability set03 / 03

08-10

3 capabilities in this set.

Part of 10 available through ReadMe.

08
List changelogs
This capability provides a list of all published changelog posts.
09
Get custom page
Use this to pull the full content of a specific custom page.
10
Get project
This capability retrieves high-level details about your ReadMe project.

Real work

What teams actually run

API Implementation

An engineer asks the AI to write a function based on the exact parameters found in the ReadMe API reference.

Documentation Audits

A writer uses the AI to find every mention of a deprecated endpoint across all pages.

Onboarding Support

A developer asks the AI to summarize the 'Getting Started' guide to understand the initial setup.

Product Update Sync

A team uses the AI to summarize recent changelogs to stay updated on new feature releases.

Automate a task

Put ReadMe to work on one thing.

Step-by-step automations your AI runs through this Connector: the workflow, the prompts to start with, and the exact capabilities behind each move.

One connector, every AI

ReadMe works with the most popular AI clients.

These are the most popular clients, each with a step-by-step guide: one link, set up once, with governance and visibility built in. And because everything runs on the MCP standard, the same connection also works in any other compatible client — nothing to rebuild.

Building your own app? The connector is yours to use.

You don't need a client to put ReadMe to work: the same hosted connection plugs into your own applications and agent code, with the same governance on every request. Build with it, chat with it — one connection for both.

Observed, not estimated

853ms average. Fast in production.

ReadMe is checked daily against the live service.

Daily averagePeak 1110ms

Oct 3Today

Fastest day: 676ms
Slowest day: 1110ms
14-day trend: Slowing+5%

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.

1In Claude Desktop, open Settings → Connectors.
2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
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

Guided setup for Claude? Set up ReadMe in Claude and other AIs

See all the AI clients this connector works with ↑

Who it's for

Built for the work ReadMe owners hand off.

This MCP is built for technical professionals who manage or consume developer-facing documentation.

01
Developer Advocates
They use the AI to verify guide accuracy and draft new content based on existing structures.
02
Technical Writers
They use the AI to audit documentation for outdated info without leaving their editor.
03
Software Engineers
They pull official API specs directly into their IDE to write compliant code.

FAQ

Questions ReadMe owners ask.

01
How do I connect my ReadMe docs to my AI?
You connect the MCP via Vinkius and provide your ReadMe API Key, which you can find in your project's Configuration settings.
02
Which AI clients can use this MCP?
This MCP works with any compatible client, including Claude, Cursor, Windsurf, and VS Code.
03
Can the AI see my private documentation?
The AI can access any documentation that your provided ReadMe API Key has permission to view.
04
Does this work with API references?
Yes, the AI can search and retrieve full content from your API reference pages.
05
Can I use this to check for recent updates?
Yes, the MCP includes capabilities to list and retrieve the full content of your changelog posts.
06
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).
07
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.
08
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

Connect ReadMe to Claude, Cursor, ChatGPT & more

Your AI does the work. We keep it safe and sound.

Each Connector runs inside its own sealed environment.

One switch stops every agent. Instantly.

Spending limits that pause instead of surprise.

We ship only the actions that matter.

01-04

List categories

Get category

List custom pages

Get doc

05-07

Get category docs

Get changelog

Search docs

08-10

List changelogs

Get custom page

Get project

What teams actually run

API Implementation

Documentation Audits

Onboarding Support

Product Update Sync

Building your own app? The connector is yours to use.

ReadMe Connector

Claude Desktop

Developer Advocates

Technical Writers

Software Engineers

How do I connect my ReadMe docs to my AI?

Which AI clients can use this MCP?

Can the AI see my private documentation?

Does this work with API references?

Can I use this to check for recent updates?

Where do I obtain my ReadMe API Key?

Does the server allow me to write or edit documentation?

In what format is the document content returned?

Document360 AI Connector

DevDocs AI Connector

DeveloperHub AI Connector

GitBook AI Connector

Suggestions

Technical Writing Prover AI Connector

Technical Writing ROI Analyzer AI Connector

Mem AI (Knowledge Workspace) AI Connector

GitScrum Knowledge AI Connector