ReadMe MCP Server for Mastra AI 10 tools — connect in under 2 minutes
Mastra AI is a TypeScript-native agent framework built for modern web stacks. Connect ReadMe through Vinkius and Mastra agents discover all tools automatically. type-safe, streaming-ready, and deployable anywhere Node.js runs.
ASK AI ABOUT THIS MCP SERVER
Vinkius supports streamable HTTP and SSE.
import { Agent } from "@mastra/core/agent";
import { createMCPClient } from "@mastra/mcp";
import { openai } from "@ai-sdk/openai";
async function main() {
// Your Vinkius token. get it at cloud.vinkius.com
const mcpClient = await createMCPClient({
servers: {
"readme": {
url: "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp",
},
},
});
const tools = await mcpClient.getTools();
const agent = new Agent({
name: "ReadMe Agent",
instructions:
"You help users interact with ReadMe " +
"using 10 tools.",
model: openai("gpt-4o"),
tools,
});
const result = await agent.generate(
"What can I do with ReadMe?"
);
console.log(result.text);
}
main();
* 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.
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.
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 Mastra AI 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 Mastra AI via MCP
Follow these steps to integrate the ReadMe MCP Server with Mastra AI.
Install dependencies
Run npm install @mastra/core @mastra/mcp @ai-sdk/openai
Replace the token
Replace [YOUR_TOKEN_HERE] with your Vinkius token
Run the agent
Save to agent.ts and run with npx tsx agent.ts
Explore tools
Mastra discovers 10 tools from ReadMe via MCP
Why Use Mastra AI with the ReadMe MCP Server
Mastra AI provides unique advantages when paired with ReadMe through the Model Context Protocol.
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 + Mastra AI Use Cases
Practical scenarios where Mastra AI combined with the ReadMe MCP Server delivers measurable value.
Automated workflows: build multi-step agents that query ReadMe, process results, and trigger downstream actions in a typed pipeline
SaaS integrations: embed ReadMe as a first-class tool in your product's AI features with Mastra's clean agent API
Background jobs: schedule Mastra agents to query ReadMe on a cron and store results in your database automatically
Multi-agent systems: create specialist agents that collaborate using ReadMe tools alongside other MCP servers
ReadMe MCP Tools for Mastra AI (10)
These 10 tools become available when you connect ReadMe to Mastra AI 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 Mastra AI
Ready-to-use prompts you can give your Mastra AI 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 Mastra AI
Common issues when connecting ReadMe to Mastra AI through the Vinkius, and how to resolve them.
createMCPClient not exported
npm install @mastra/mcpReadMe + Mastra AI FAQ
Common questions about integrating ReadMe MCP Server with Mastra AI.
How does Mastra AI connect to MCP servers?
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?
Does Mastra support workflow orchestration?
Connect ReadMe with your favorite client
Step-by-step setup guides for every MCP-compatible client and framework:
Anthropic's native desktop app for Claude with built-in MCP support.
AI-first code editor with integrated LLM-powered coding assistance.
GitHub Copilot in VS Code with Agent mode and MCP support.
Purpose-built IDE for agentic AI coding workflows.
Autonomous AI coding agent that runs inside VS Code.
Anthropic's agentic CLI for terminal-first development.
Python SDK for building production-grade OpenAI agent workflows.
Google's framework for building production AI agents.
Type-safe agent development for Python with first-class MCP support.
TypeScript toolkit for building AI-powered web applications.
TypeScript-native agent framework for modern web stacks.
Python framework for orchestrating collaborative AI agent crews.
Leading Python framework for composable LLM applications.
Data-aware AI agent framework for structured and unstructured sources.
Microsoft's framework for multi-agent collaborative conversations.
Connect ReadMe to Mastra AI
Get your token, paste the configuration, and start using 10 tools in under 2 minutes. No API key management needed.