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

Name: ReadMe
Availability: InStock
Author: Vinkius

microsoft.github.io/autogen/docs/tools/mcp-tools

Built by Vinkius GDPR 10 Tools Framework

Microsoft AutoGen enables multi-agent conversations where agents negotiate, delegate, and execute tasks collaboratively. Add ReadMe as an MCP tool provider through Vinkius and every agent in the group can access live data and take action.

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

import asyncio
from autogen_agentchat.agents import AssistantAgent
from autogen_ext.tools.mcp import McpWorkbench

async def main():
    # Your Vinkius token. get it at cloud.vinkius.com
    async with McpWorkbench(
        server_params={"url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"},
        transport="streamable_http",
    ) as workbench:
        tools = await workbench.list_tools()
        agent = AssistantAgent(
            name="readme_agent",
            tools=tools,
            system_message=(
                "You help users with ReadMe. "
                "10 tools available."
            ),
        )
        print(f"Agent ready with {len(tools)} tools")

asyncio.run(main())

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.

AutoGen enables multi-agent conversations where agents negotiate, delegate, and collaboratively use ReadMe tools. Connect 10 tools through Vinkius and assign role-based access. a data analyst queries while a reviewer validates, with optional human-in-the-loop approval for sensitive operations.

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 AutoGen 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 AutoGen via MCP

Follow these steps to integrate the ReadMe MCP Server with AutoGen.

Install AutoGen

Run pip install "autogen-ext[mcp]"

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token

Integrate into workflow

Use the agent in your AutoGen multi-agent orchestration

Explore tools

The workbench discovers 10 tools from ReadMe automatically

Why Use AutoGen with the ReadMe MCP Server

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

Multi-agent conversations: multiple AutoGen agents discuss, delegate, and collaboratively use ReadMe tools to solve complex tasks

Role-based architecture lets you assign ReadMe tool access to specific agents. a data analyst queries while a reviewer validates

Human-in-the-loop support: agents can pause for human approval before executing sensitive ReadMe tool calls

Code execution sandbox: AutoGen agents can write and run code that processes ReadMe tool responses in an isolated environment

ReadMe + AutoGen Use Cases

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

Collaborative analysis: one agent queries ReadMe while another validates results and a third generates the final report

Automated review pipelines: a researcher agent fetches data from ReadMe, a critic agent evaluates quality, and a writer produces the output

Interactive planning: agents negotiate task allocation using ReadMe data to make informed decisions about resource distribution

Code generation with live data: an AutoGen coder agent writes scripts that process ReadMe responses in a sandboxed execution environment

ReadMe MCP Tools for AutoGen (10)

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

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

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

McpWorkbench not found

Install: pip install "autogen-ext[mcp]"

ReadMe + AutoGen FAQ

Common questions about integrating ReadMe MCP Server with AutoGen.

How does AutoGen connect to MCP servers?

Create an MCP tool adapter and assign it to one or more agents in the group chat. AutoGen agents can then call ReadMe tools during their conversation turns.

Can different agents have different MCP tool access?

Yes. AutoGen's role-based architecture lets you assign specific MCP tools to specific agents, so a querying agent has different capabilities than a reviewing agent.