ReadMe MCP. Search your entire developer knowledge base from chat.
Works with every AI agent you already use
…and any MCP-compatible client
Just plug in your AI agents and start using Vinkius.
ReadMe MCP Server lets your AI client search, read, and manage developer documentation directly from your ReadMe project. It provides tools to perform full-text searches across all guides, retrieve the exact content of any page or changelog, and list structured categories for instant knowledge access.
What your AI agents can do
Get category
Retrieves specific details for a single documentation category.
Get category docs
Lists all individual documentation pages that fall under a specified category.
Get changelog
Retrieves the full, detailed content of one specific changelog post by its title or identifier.
Runs search_docs to perform full-text queries across all published guides and API references.
Retrieves the complete Markdown content of a single, specific documentation page using get_doc.
Accesses the history by listing all changelog posts via list_changelogs or fetching a full post with get_changelog.
Determines the site's hierarchy by listing top-level documentation categories using list_categories.
Retrieves content from standalone, custom-built pages via tools like get_custom_page or list_custom_pages.
Ask AI about this MCP
Supported MCP Clients
Waiting for input…
ReadMe MCP Server: 10 Tools for Documentation Management
Use these ten specific functions to search, list, and retrieve structured content from your ReadMe project's entire documentation hub.
019d75fcget category
Retrieves specific details for a single documentation category.
019d75fcget category docs
Lists all individual documentation pages that fall under a specified category.
019d75fcget changelog
Retrieves the full, detailed content of one specific changelog post by its title or identifier.
019d75fcget custom page
Pulls the complete Markdown content from a standalone custom page.
019d75fcget doc
Retrieves the full Markdown content of a specific documentation page by its identifier.
019d75fcget project
Retrieves high-level structural details about your entire ReadMe project.
019d75fclist categories
Lists every main documentation category available on the site, giving you a map of the content structure.
019d75fclist changelogs
Lists all published changelog posts so you can see what major updates have happened over time.
019d75fclist custom pages
Lists every standalone, custom-built page that exists outside the main documentation structure.
019d75fcsearch docs
Runs a full-text search across all published guides and API references to find relevant snippets.
Choose How to Get Started
Build a custom MCP for your own tools, or connect a ready-made integration from our catalog.
Build Your Own
Turn any API into an MCP. Import a spec, define Agent Skills, or deploy with MCPFusion.
- Import from OpenAPI, Swagger, or YAML specs
- Create Agent Skills with progressive disclosure
- Deploy to edge with MCPFusion framework
- Built in DLP, auth, and compliance on every call
- Real time usage dashboard and cost metering
- Publish to catalog or keep private
Make Your AI Do More
Start with ReadMe, then connect any of our 4,700+ other servers whenever your AI needs more. One click, no limits.
- Use this MCP plus 4,700+ others, all in one place
- Add new capabilities to your AI anytime you want
- Every connection is secured and compliant automatically
- Track usage and costs across all your servers
- Works with Claude, ChatGPT, Cursor, and more
- New servers added to the catalog every week
What you can do with this MCP connector
Your AI client needs direct access to your company's knowledge base. This server connects it straight to your ReadMe developer documentation, letting your agent search, read, and manage every guide, changelog, and custom page like a human tech writer would.
Searching the Guides. When you need specific info, you run search_docs to perform full-text queries across all published guides and API references. That tool finds relevant snippets instantly, so your agent doesn't waste time reading pages it doesn't need to.
Pinpointing Content. If you know the exact page ID, you use get_doc to pull the complete Markdown content of that specific documentation page. For standalone sections that don't fit into a main guide, you use get_custom_page to get its full text. You can also check out high-level structural details for your whole ReadMe setup by calling get_project.
Mapping the Structure. To understand how everything fits together, you list all top-level documentation categories using list_categories. That gives you a map of the site's content structure. If you want to drill down into what belongs in one of those sections, you use get_category_docs to list every individual page under a specified category, and then get_category retrieves specific details about that single category itself.
Handling Custom Builds. For pages built outside the standard documentation flow, your agent first calls list_custom_pages to see what exists. It then uses get_custom_page to pull in the full content of any standalone page you've created.
Tracking Changes and History. Keeping track of updates is a job for two tools. You run list_changelogs to get an index of every published changelog post, letting your agent see what major changes have happened over time. When you need the full scoop on one release, you use get_changelog to retrieve all the detailed content for that specific title or identifier.
Your AI client can now execute these actions—search, list, get details, and fetch content across guides, categories, changelogs, and custom pages—all from a single chat interface.
How ReadMe MCP Works
- 1 First, authorize the ReadMe MCP server in your environment and provide it with your API Key.
- 2 Next, prompt your AI agent to perform a specific action—like 'Search for webhook setup instructions' or 'List all categories.'
- 3 The agent uses the appropriate tool (e.g.,
search_docsorlist_categories) and returns structured data containing the requested content.
The bottom line is you talk to your AI agent, and it talks to your documentation server for you.
Who Is ReadMe MCP For?
This is for technical writers and developer advocates who are sick of manually searching through multiple guides. If you spend time copying API endpoints or asking colleagues what the last changelog said, this saves you hours. It puts your entire knowledge base right into your chat window.
You use search_docs to audit existing documentation for outdated references and verify technical accuracy before publishing.
You pull specific API reference content using get_doc or structure guides by calling list_categories when drafting new educational materials.
You connect your IDE to the server and use it to instantly retrieve official company API documentation, ensuring your code matches published standards.
What Changes When You Connect
- Stop switching tabs. You can run
search_docsand get instant, full-text results across every guide without leaving your IDE or chat window. - Never miss an update. Use
list_changelogsandget_changelogto quickly pull the exact details of any product release announcement. - Understand your structure immediately. Calling
list_categoriesgives you a complete map of your site's documentation hierarchy in seconds. - Fetch content directly. Instead of copying links, use
get_docorget_category_docsto pull the clean Markdown for any page into your agent's context. - Verify code compliance. Engineers can pass API references through
get_projectto ensure their work aligns with official standards.
Real-World Use Cases
Onboarding a New Hire
A new developer needs the setup steps for webhooks, but they don't know where to look. They ask their agent: 'What are the webhook instructions?' The agent uses search_docs, finds the 'Webhook Installation Guide,' and returns the step-by-step guide instantly.
Writing a Quarterly Report
A developer advocate needs to prove that API v1 is deprecated. They run list_changelogs and then target the specific post using get_changelog to pull documentation proving the deprecation notices.
Updating an Outdated Guide
A technical writer finds a guide referencing old API paths. They use search_docs to locate all instances of 'v1 metrics path' and then review the official changes using get_changelog, ensuring they update every reference.
Mapping Product Expansion
A product manager wants to see what documentation is available in a specific section. They first run list_categories to map out main areas, then use get_category_docs on the 'Authentication' category to list all related guides.
The Tradeoffs
Copy/Pasting everything
The user manually opens 5 tabs (API docs, changelog, guide) and copies chunks of text into the chat to summarize them for a teammate. This is slow, error-prone, and tedious.
→
Instead, ask your agent to run search_docs with specific keywords or use get_doc directly on the required page slug. The agent pulls the clean source material for you.
Guessing which tool works
The user tries running both get_doc and search_docs because they aren't sure if the information is a full page or just a snippet. They waste time on redundant calls.
→
If you need specific content from a known URL, use get_doc. If you only know keywords but not the exact page location, run search_docs first.
Ignoring the structure
The user asks for 'all documentation' which is too vague. The agent can't narrow down if they mean categories or individual pages.
→
Start by running list_categories to get a map of the site, then use get_category_docs on the relevant category name.
When It Fits, When It Doesn't
Use this server when your job involves reading and synthesizing information from structured developer documentation. You need to know what exists (use list_categories, list_changelogs), or you need specific facts about a page, like the exact content of an API endpoint (get_doc). Don't use it if your question is general, high-level strategy ('How should we improve our documentation?'); those are discussion points. If you just need to know what was released last week, run list_changelogs first. Never assume that running a search is enough; always verify the results by targeting specific content using get_doc or get_category_docs if possible. The strength here is knowing exactly where to look.
Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by ReadMe. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.
VINKIUS INFRASTRUCTURE
Cloud Hosted
Managed infra
V8 Isolated
Sandboxed per request
Zero-Trust Proxy
No stored credentials
DLP Enforced
Policy on every call
GDPR Compliant
EU data residency
Token Compression
~60% cost reduction
Works with Claude, ChatGPT, Cursor, and more
The Model Context Protocol standardizes how applications expose capabilities to LLMs. Instead of operating in isolation, your AI gains direct access to external platforms, live data, and real-world actions through secure, standardized connections.
This server provides 10 capabilities that interface natively with Claude, ChatGPT, Cursor, and any MCP client. No middleware. No custom integration required.
Available Capabilities
Finding the right piece of documentation shouldn't feel like navigating a maze.
Right now, figuring out how something works means clicking through category menus, finding the correct guide slug, and then copying text snippets from three different tabs just to summarize it for your team. It’s constant context switching—a huge time sink.
With this MCP server, you simply ask your agent: 'What are the rules for webhooks?' The agent runs `search_docs`, pulls the core guide content via tools like `get_doc`, and gives you a clean summary right in the chat. It's faster and more reliable.
ReadMe MCP Server: Pulling structured data with specific tools.
Before, tracking changes meant visiting the changelog page manually every few days to see what was new. You had no way of knowing if a guide or an API endpoint reference was updated unless you remembered to check it yourself.
Now, you can call `list_changelogs` and then pinpoint exactly what changed with `get_changelog`. It gives your agent the verified source material instantly. No more guessing.
Common Questions About ReadMe MCP
How do I search for documentation using the search_docs tool? +
You send a plain text query to your agent, which runs search_docs. The agent returns full-text matches across all guides. This is best when you know keywords but not the specific page name.
Can I list all available documentation categories using list_categories? +
Yes, running list_categories gives a comprehensive map of your site's structure (e.g., 'Authentication', 'REST API Reference'). This tells you what major topics exist.
What's the difference between get_doc and search_docs? +
Use search_docs when you are looking for keywords anywhere in your documentation. Use get_doc when you know the exact page slug or ID you need to retrieve.
How do I find out what was released last week? +
First, run list_changelogs to see a list of all posts. Then, use get_changelog with the specific title or date range to pull the full content for that release.
Which tool do I use to view documentation under one section? +
If you know the category name and want all pages in it, run get_category_docs. This lists every page related to that specific topic area.
What information can I get about the overall project using the get_project tool? +
The get_project tool provides high-level metadata for your entire ReadMe documentation hub. You'll find details like the current version number, primary domain name, and global last updated date.
How do I view content that isn't a standard guide using the get_custom_page tool? +
Use get_custom_page to pull full content from standalone pages. This is for documentation like internal policy guides or temporary announcements, separate from your main API references.
If I need a list of all available changelogs, which tool should I use? (list_changelogs) +
You must start with list_changelogs. This function returns an array of titles and dates for every published release. After listing them, you then use get_changelog to pull the full content.
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.
Use it with your favorite AI tools
Connect this server to Cursor, Claude, VS Code, and more.
More in this category
Fly.io Extended
Manage Fly.io apps, machines, and infrastructure—provision resources, control machine lifecycles, and manage volumes directly from any AI agent.
Scaleway
Manage Scaleway cloud infrastructure — list, create, and control virtual instances directly from your AI agent.
SerpApi
Equip your AI agent with real-time web search capabilities across Google, Bing, Baidu, Yahoo, and DuckDuckGo.
You might also like
Birdeye
Grow your local business reputation with review management, customer surveys, and listings that drive more foot traffic.
LinkedIn Page Management
Manage Company Page posts, comments, and social actions via the LinkedIn REST API.
NLP Cloud
High-performance NLP API for text summarization, entity extraction, classification, sentiment analysis, ASR, and translation.