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 Google ADK 10 tools — connect in under 2 minutes

Name: ReadMe
Availability: InStock
Author: Vinkius

google.github.io/adk-docs/tools/mcp-tools

Built by Vinkius GDPR 10 Tools SDK

Google Agent Development Kit (ADK) is Google's framework for building production AI agents. Add ReadMe as an MCP tool provider through Vinkius and your ADK agents can call every tool with full schema introspection.

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.

python

from google.adk.agents import Agent
from google.adk.tools.mcp_tool import McpToolset
from google.adk.tools.mcp_tool.mcp_session_manager import (
    StreamableHTTPConnectionParams,
)

# Your Vinkius token. get it at cloud.vinkius.com
mcp_tools = McpToolset(
    connection_params=StreamableHTTPConnectionParams(
        url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp",
    )
)

agent = Agent(
    model="gemini-2.5-pro",
    name="readme_agent",
    instruction=(
        "You help users interact with ReadMe "
        "using 10 available tools."
    ),
    tools=[mcp_tools],
)

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.

Google ADK natively supports ReadMe as an MCP tool provider. declare Vinkius Edge URL and the framework handles discovery, validation, and execution automatically. Combine 10 tools with Gemini's long-context reasoning for complex multi-tool workflows, with production-ready session management and evaluation built in.

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 Google ADK 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 Google ADK via MCP

Follow these steps to integrate the ReadMe MCP Server with Google ADK.

Install Google ADK

Run pip install google-adk

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token

Create the agent

Save the code above and integrate into your ADK workflow

Explore tools

The agent will discover 10 tools from ReadMe via MCP

Why Use Google ADK with the ReadMe MCP Server

Google ADK provides unique advantages when paired with ReadMe through the Model Context Protocol.

Google ADK natively supports MCP tool servers. declare a tool provider and the framework handles discovery, validation, and execution

Built on Gemini models, ADK provides long-context reasoning ideal for complex multi-tool workflows with ReadMe

Production-ready features like session management, evaluation, and deployment come built-in. not bolted on

Seamless integration with Google Cloud services means you can combine ReadMe tools with BigQuery, Vertex AI, and Cloud Functions

ReadMe + Google ADK Use Cases

Practical scenarios where Google ADK combined with the ReadMe MCP Server delivers measurable value.

Enterprise data agents: ADK agents query ReadMe and cross-reference results with internal databases for comprehensive analysis

Multi-modal workflows: combine ReadMe tool responses with Gemini's vision and language capabilities in a single agent

Automated compliance checks: schedule ADK agents to query ReadMe regularly and flag policy violations or configuration drift

Internal tool platforms: build self-service agent platforms where teams connect their own MCP servers including ReadMe

ReadMe MCP Tools for Google ADK (10)

These 10 tools become available when you connect ReadMe to Google ADK 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 Google ADK

Ready-to-use prompts you can give your Google ADK 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 Google ADK

Common issues when connecting ReadMe to Google ADK through the Vinkius, and how to resolve them.

McpToolset not found

Update: pip install --upgrade google-adk

ReadMe + Google ADK FAQ

Common questions about integrating ReadMe MCP Server with Google ADK.

How does Google ADK connect to MCP servers?

Import the MCP toolset class and pass the server URL. ADK discovers and registers all tools automatically, making them available to your agent's tool-use loop.

Can ADK agents use multiple MCP servers?

Yes. Declare multiple MCP tool providers in your agent configuration. ADK merges all tool schemas and the agent can call tools from any server in a single turn.

Which Gemini models work best with MCP tools?

Gemini 2.0 Flash and Pro models both support function calling required for MCP tools. Flash is recommended for latency-sensitive use cases, Pro for complex reasoning.