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.

ReadMe MCP Server for Claude Desktop 10 tools — connect in under 2 minutes

Name: ReadMe
Availability: InStock
Author: Vinkius

modelcontextprotocol.io/quickstart/user

Built by Vinkius GDPR 10 Tools IDE

Claude Desktop is Anthropic's native application for interacting with Claude AI models on macOS and Windows. It was the first consumer application to ship with built-in MCP support, making it the reference implementation for the Model Context Protocol standard.

Get MCP Server for AI Agents

ASK AI ABOUT THIS MCP SERVER

Open in ChatGPT Open in Claude Open in Perplexity

Vinkius supports streamable HTTP and SSE.

RecommendedModern Approach — Zero Configuration

Vinkius Desktop App

The modern way to manage MCP Servers — no config files, no terminal commands. Install ReadMe and 2,500+ MCP Servers from a single visual interface.

Download Free Open SourceNo signup required

Classic Setup·json

{
  "mcpServers": {
    "readme": {
      // Your Vinkius token. get it at cloud.vinkius.com
      "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    }
  }
}

Fully ManagedVinkius Servers

60%Token savings

High SecurityEnterprise-grade

IAMAccess control

EU AI ActCompliant

DLPData protection

V8 IsolateSandboxed

Ed25519Audit chain

<40msKill switch

Stream every event to Splunk, Datadog, or your own webhook in real-time

* Every MCP server runs on Vinkius-managed infrastructure inside AWS - a purpose-built runtime with per-request V8 isolates, Ed25519 signed audit chains, and sub-40ms cold starts optimized for native MCP execution. See our infrastructure

About ReadMe MCP Server

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.

Claude Desktop is the definitive way to connect ReadMe to your AI workflow. Add Vinkius Edge URL to your config, restart the app, and Claude immediately exposes all 10 tools in the chat interface. ask a question, Claude calls the right tool, and you see the answer. Zero code, zero 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.

The ReadMe MCP Server exposes 10 tools through the Vinkius. Connect it to Claude Desktop in under two minutes — no API keys to rotate, no infrastructure to provision, no vendor lock-in. Your configuration, your data, your control.

How to Connect ReadMe to Claude Desktop via MCP

Follow these steps to integrate the ReadMe MCP Server with Claude Desktop.

Open Claude Desktop Settings

Go to Settings → Developer → Edit Config to open claude_desktop_config.json

Add the MCP Server

Paste the configuration above into the mcpServers section

Restart Claude Desktop

Close and reopen Claude Desktop to load the new server

Start using ReadMe

Look for the 🔌 icon in the chat. your 10 tools are now available

Why Use Claude Desktop with the ReadMe MCP Server

Claude Desktop by Anthropic provides unique advantages when paired with ReadMe through the Model Context Protocol.

Claude Desktop is the reference MCP client. it was designed alongside the protocol itself, ensuring the most complete and stable MCP implementation available

Zero-code configuration: add a server URL to a JSON file and Claude instantly discovers and exposes all available tools in the chat interface

Claude's extended thinking capability lets it reason through multi-step tool usage, chaining multiple API calls to answer complex questions

Enterprise-grade security with local config storage. your tokens never leave your machine, and connections go directly to Vinkius Edge network

ReadMe + Claude Desktop Use Cases

Practical scenarios where Claude Desktop combined with the ReadMe MCP Server delivers measurable value.

Interactive data exploration: ask Claude to query DNS records, look up WHOIS data, and cross-reference results in a single conversation

Ad-hoc security audits: type a domain name and let Claude enumerate subdomains, check DNS history, and flag configuration anomalies. all through natural language

Executive briefings: generate comprehensive domain intelligence reports by asking Claude to compile findings into a formatted summary

Learning and training: new team members can explore API capabilities conversationally without needing to read documentation

ReadMe MCP Tools for Claude Desktop (10)

These 10 tools become available when you connect ReadMe to Claude Desktop via MCP:

get_category

Retrieves details for a specific documentation category

get_category_docs

Lists all documentation pages under a specific category

get_changelog

Retrieves the full content of a specific changelog post

get_custom_page

Retrieves the full content of a custom page

get_doc

Retrieves the full content of a documentation page

get_project

Retrieves details about the ReadMe project

list_categories

Lists all documentation categories on ReadMe

list_changelogs

Lists all changelog posts

list_custom_pages

Lists all custom standalone pages

search_docs

Performs a full-text search across all documentation pages

Example Prompts for ReadMe in Claude Desktop

Ready-to-use prompts you can give your Claude Desktop agent to start working with ReadMe immediately.

"Search the documentation for instructions on configuring webhooks."

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

"List all main documentation categories."

Troubleshooting ReadMe MCP Server with Claude Desktop

Common issues when connecting ReadMe to Claude Desktop through the Vinkius, and how to resolve them.

Server not appearing after restart

Ensure the JSON is valid (no trailing commas). Check the file path: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\\Claude\\ (Windows).

Authentication error

Verify your Vinkius token is correct. Go to cloud.vinkius.com to regenerate it if needed.

Tools not showing in chat

Click the 🔌 icon at the bottom of the chat input. If it shows 0 tools, the server may still be connecting. wait a few seconds.

ReadMe + Claude Desktop FAQ

Common questions about integrating ReadMe MCP Server with Claude Desktop.

How does Claude Desktop discover MCP tools?

When Claude Desktop starts, it reads the claude_desktop_config.json file and connects to each configured MCP server. It calls the tools/list endpoint to fetch the schema for every available tool, then surfaces them as clickable options in the chat interface via the 🔌 icon.

What happens if the MCP server is temporarily unavailable?

Claude Desktop handles disconnections gracefully. if the server is unreachable at startup, the tools simply won't appear. Once the server becomes available again, restarting Claude Desktop will re-establish the connection. There is no timeout penalty or error loop.

Can I connect multiple MCP servers simultaneously?

Yes. You can add as many servers as you need in the mcpServers section of the config file. Each server appears as a separate tool provider, and Claude can use tools from multiple servers in a single conversation turn.

Is there a limit on the number of tools per server?

Claude Desktop can handle hundreds of tools per server. However, for optimal LLM performance, Vinkius servers are designed to expose focused, well-documented tool sets rather than overwhelming the model with too many options.

Does Claude Desktop support Streamable HTTP transport?

Yes. Claude Desktop supports both SSE (Server-Sent Events) and the newer Streamable HTTP transport that Vinkius uses. Simply provide the server URL. Claude auto-negotiates the transport protocol.