ReadMe MCP Server for Vercel AI SDK 10 tools — connect in under 2 minutes
The Vercel AI SDK is the TypeScript toolkit for building AI-powered applications. Connect ReadMe through Vinkius and every tool is available as a typed function. ready for React Server Components, API routes, or any Node.js backend.
ASK AI ABOUT THIS MCP SERVER
Vinkius supports streamable HTTP and SSE.
import { createMCPClient } from "@ai-sdk/mcp";
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";
async function main() {
const mcpClient = await createMCPClient({
transport: {
type: "http",
// Your Vinkius token. get it at cloud.vinkius.com
url: "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp",
},
});
try {
const tools = await mcpClient.tools();
const { text } = await generateText({
model: openai("gpt-4o"),
tools,
prompt: "Using ReadMe, list all available capabilities.",
});
console.log(text);
} finally {
await mcpClient.close();
}
}
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.
The Vercel AI SDK gives every ReadMe tool full TypeScript type inference, IDE autocomplete, and compile-time error checking. Connect 10 tools through Vinkius and stream results progressively to React, Svelte, or Vue components. works on Edge Functions, Cloudflare Workers, and any Node.js runtime.
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 Vercel AI SDK 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 Vercel AI SDK via MCP
Follow these steps to integrate the ReadMe MCP Server with Vercel AI SDK.
Install dependencies
Run npm install @ai-sdk/mcp ai @ai-sdk/openai
Replace the token
Replace [YOUR_TOKEN_HERE] with your Vinkius token
Run the script
Save to agent.ts and run with npx tsx agent.ts
Explore tools
The SDK discovers 10 tools from ReadMe and passes them to the LLM
Why Use Vercel AI SDK with the ReadMe MCP Server
Vercel AI SDK provides unique advantages when paired with ReadMe through the Model Context Protocol.
TypeScript-first: every MCP tool gets full type inference, IDE autocomplete, and compile-time error checking out of the box
Framework-agnostic core works with Next.js, Nuxt, SvelteKit, or any Node.js runtime. same ReadMe integration everywhere
Built-in streaming UI primitives let you display ReadMe tool results progressively in React, Svelte, or Vue components
Edge-compatible: the AI SDK runs on Vercel Edge Functions, Cloudflare Workers, and other edge runtimes for minimal latency
ReadMe + Vercel AI SDK Use Cases
Practical scenarios where Vercel AI SDK combined with the ReadMe MCP Server delivers measurable value.
AI-powered web apps: build dashboards that query ReadMe in real-time and stream results to the UI with zero loading states
API backends: create serverless endpoints that orchestrate ReadMe tools and return structured JSON responses to any frontend
Chatbots with tool use: embed ReadMe capabilities into conversational interfaces with streaming responses and tool call visibility
Internal tools: build admin panels where team members interact with ReadMe through natural language queries
ReadMe MCP Tools for Vercel AI SDK (10)
These 10 tools become available when you connect ReadMe to Vercel AI SDK 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 Vercel AI SDK
Ready-to-use prompts you can give your Vercel AI SDK 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 Vercel AI SDK
Common issues when connecting ReadMe to Vercel AI SDK through the Vinkius, and how to resolve them.
createMCPClient is not a function
npm install @ai-sdk/mcpReadMe + Vercel AI SDK FAQ
Common questions about integrating ReadMe MCP Server with Vercel AI SDK.
How does the Vercel AI SDK connect to MCP servers?
createMCPClient from @ai-sdk/mcp and pass the server URL. The SDK discovers all tools and provides typed TypeScript interfaces for each one.Can I use MCP tools in Edge Functions?
Does it support streaming tool results?
useChat and streamText that handle tool calls and display results progressively in the UI.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 Vercel AI SDK
Get your token, paste the configuration, and start using 10 tools in under 2 minutes. No API key management needed.
