Bring Api Documentation
to Mastra AI
Create your Vinkius account to connect ReadMe to Mastra AI and start using all 10 AI tools in minutes. Fully managed, enterprise secure, and ready to use without writing a single line of code. No hosting, no server setup — just connect and start using.
GDPR Free for SubscribersCompatible with every major AI agent and IDE
Gemini
What is the 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.
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.
How it works
- Authorize the ReadMe MCP server in your environment.
- Provide your ReadMe API Key (found under your project's Configuration settings).
- Ask your AI to summarize a specific API endpoint's documentation or list recent changelogs directly from your chat.
Who is this for?
- Developer Advocates — Verify the accuracy of published guides and quickly draft new content referencing existing structures.
- Technical Writers — Search and audit current documentation for outdated references without leaving your code editor.
- Software Engineers — Instantly pull your company's official API documentation into your IDE to ensure your code aligns with published standards.
Built-in capabilities (10)
Retrieves details for a specific documentation category
Lists all documentation pages under a specific category
Retrieves the full content of a specific changelog post
Retrieves the full content of a custom page
Retrieves the full content of a documentation page
Retrieves details about the ReadMe project
Lists all documentation categories on ReadMe
Lists all changelog posts
Lists all custom standalone pages
Performs a full-text search across all documentation pages
Why Mastra AI?
Mastra's agent abstraction provides a clean separation between LLM logic and ReadMe tool infrastructure. Connect 10 tools through Vinkius and use Mastra's built-in workflow engine to chain tool calls with conditional logic, retries, and parallel execution. deployable to any Node.js host in one command.
- —
Mastra's agent abstraction provides a clean separation between LLM logic and tool infrastructure. add ReadMe without touching business code
- —
Built-in workflow engine chains MCP tool calls with conditional logic, retries, and parallel execution for complex automation
- —
TypeScript-native: full type inference for every ReadMe tool response with IDE autocomplete and compile-time checks
- —
One-command deployment to any Node.js host. Vercel, Railway, Fly.io, or your own infrastructure
ReadMe in Mastra AI
Why run ReadMe with Vinkius?
The ReadMe connection runs on our fully managed, secure cloud infrastructure. We handle the hosting, maintenance, and security so you don't have to deal with servers or code. All 10 tools are ready to work instantly without any complex setup.
You stay in complete control of your data. Your AI only accesses the information you approve, keeping your sensitive passwords and private details completely safe. Plus, with automatic optimizations, your AI works faster and more efficiently.
* Every connection is hosted and maintained by Vinkius. We handle the security, updates, and infrastructure so you don't have to write code or manage servers. See our infrastructure
Over 4,000 integrations ready for AI agents
Explore a vast library of pre-built integrations, optimized and ready to deploy.
Connect securely in under 30 seconds
Generate tokens to authenticate and link external services in a single step.
Complete visibility into every agent action
Audit live requests, latency, success rates, and active security compliance policies.
Optimize spending and track token ROI
Analyze real-time token consumption and cost metrics detailed by connection.
Explore our live AI Agents Analytics dashboard to see it all working
This dashboard is included when you connect ReadMe using Vinkius. You will never be left in the dark about what your AI agents are doing with your tools.
ReadMe and 4,000+ other AI tools. No hosting, no code, ready to use.
Professionals who connect ReadMe to Mastra AI through Vinkius don't need to write code, manage servers, or worry about security. Everything is pre-configured, secure, and runs automatically in the background.
Raw MCP | Vinkius | |
|---|---|---|
| Ready-to-use MCPs | Find and configure each manually | 4,000+ MCPs ready to use |
| Connection Setup | Manual coding & server setup | 1-click instant connection |
| Server Hosting | You host it yourself (needs 24/7 uptime) | 100% hosted & managed by Vinkius |
| Security & Privacy | Stored in plaintext config files | Bank-grade encrypted vault |
| Activity Visibility | Blind execution (no logs or tracking) | Live dashboard with real-time logs |
| Cost Control | Runaway AI token spend risk | Automatic budget limits |
| Revoking Access | Must delete files or code to stop | 1-click disconnect button |
How Vinkius secures
ReadMe for Mastra AI
Every request between Mastra AI and ReadMe is protected by our secure gateway. We automatically keep your sensitive data private, prevent unauthorized access, and let you disconnect instantly at any time.
Frequently asked questions
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.
How does Mastra AI connect to MCP servers?
Create an MCPClient with the server URL and pass it to your agent. Mastra discovers all tools and makes them available with full TypeScript types.
Can Mastra agents use tools from multiple servers?
Yes. Pass multiple MCP clients to the agent constructor. Mastra merges all tool schemas and the agent can call any tool from any server.
Does Mastra support workflow orchestration?
Yes. Mastra has a built-in workflow engine that lets you chain MCP tool calls with branching logic, error handling, and parallel execution.
createMCPClient not exported
Install: npm install @mastra/mcp
Explore More MCP Servers
View all →
Checkbook.io
8 toolsManage digital and physical check payments via Checkbook — send money, track checks, and monitor invoices directly from any AI agent.
Sobot
10 toolsLeading AI customer support and ticketing platform in China — manage tickets, agents, and knowledge via AI.
Shopline
7 toolsEquip your AI agent to autonomously manage your Shopline store. Audit products, track order fulfillment, fetch customer profiles, and monitor store collections seamlessly.
Moosend (Email Marketing & Automation)
10 toolsManage email marketing via Moosend — create campaigns, track mailing lists, and audit performance analytics.