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

Name: ReadMe
Availability: InStock
Author: Vinkius

docs.crewai.com/mcp/overview

Built by Vinkius GDPR 10 Tools Framework

Connect your CrewAI agents to ReadMe through Vinkius, pass the Edge URL in the `mcps` parameter and every ReadMe tool is auto-discovered at runtime. No credentials to manage, no infrastructure to maintain.

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 crewai import Agent, Task, Crew

agent = Agent(
    role="ReadMe Specialist",
    goal="Help users interact with ReadMe effectively",
    backstory=(
        "You are an expert at leveraging ReadMe tools "
        "for automation and data analysis."
    ),
    # Your Vinkius token. get it at cloud.vinkius.com
    mcps=["https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"],
)

task = Task(
    description=(
        "Explore all available tools in ReadMe "
        "and summarize their capabilities."
    ),
    agent=agent,
    expected_output=(
        "A detailed summary of 10 available tools "
        "and what they can do."
    ),
)

crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
print(result)

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.

When paired with CrewAI, ReadMe becomes a first-class tool in your multi-agent workflows. Each agent in the crew can call ReadMe tools autonomously, one agent queries data, another analyzes results, a third compiles reports, all orchestrated through Vinkius with zero configuration overhead.

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

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

Install CrewAI

Run pip install crewai

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token from cloud.vinkius.com

Customize the agent

Adjust the role, goal, and backstory to fit your use case

Run the crew

Run python crew.py. CrewAI auto-discovers 10 tools from ReadMe

Why Use CrewAI with the ReadMe MCP Server

CrewAI Multi-Agent Orchestration Framework provides unique advantages when paired with ReadMe through the Model Context Protocol.

Multi-agent collaboration lets you decompose complex workflows into specialized roles, one agent researches, another analyzes, a third generates reports, each with access to MCP tools

CrewAI's native MCP integration requires zero adapter code: pass Vinkius Edge URL directly in the `mcps` parameter and agents auto-discover every available tool at runtime

Built-in task delegation and shared memory mean agents can pass context between steps without manual state management, enabling multi-hop reasoning across tool calls

Sequential and hierarchical crew patterns map naturally to real-world workflows: enumerate subdomains → analyze DNS history → check WHOIS records → compile findings into actionable reports

ReadMe + CrewAI Use Cases

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

Automated multi-step research: a reconnaissance agent queries ReadMe for raw data, then a second analyst agent cross-references findings and flags anomalies. all without human handoff

Scheduled intelligence reports: set up a crew that periodically queries ReadMe, analyzes trends over time, and generates executive briefings in markdown or PDF format

Multi-source enrichment pipelines: chain ReadMe tools with other MCP servers in the same crew, letting agents correlate data across multiple providers in a single workflow

Compliance and audit automation: a compliance agent queries ReadMe against predefined policy rules, generates deviation reports, and routes findings to the appropriate team

ReadMe MCP Tools for CrewAI (10)

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

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

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

MCP tools not discovered

Ensure the Edge URL is correct. CrewAI connects lazily when the crew starts. check console output.

Agent not using tools

Make the task description specific. Instead of "do something", say "Use the available tools to list contacts".

Timeout errors

CrewAI has a 10s connection timeout by default. Ensure your network can reach the Edge URL.

Rate limiting or 429 errors

Vinkius enforces per-token rate limits. Check your subscription tier and request quota in the dashboard. Upgrade if you need higher throughput.

ReadMe + CrewAI FAQ

Common questions about integrating ReadMe MCP Server with CrewAI.

How does CrewAI discover and connect to MCP tools?

CrewAI connects to MCP servers lazily. when the crew starts, each agent resolves its MCP URLs and fetches the tool catalog via the standard tools/list method. This means tools are always fresh and reflect the server's current capabilities. No tool schemas need to be hardcoded.

Can different agents in the same crew use different MCP servers?

Yes. Each agent has its own mcps list, so you can assign specific servers to specific roles. For example, a reconnaissance agent might use a domain intelligence server while an analysis agent uses a vulnerability database server.

What happens when an MCP tool call fails during a crew run?

CrewAI wraps tool failures as context for the agent. The LLM receives the error message and can decide to retry with different parameters, fall back to a different tool, or mark the task as partially complete. This resilience is critical for production workflows.

Can CrewAI agents call multiple MCP tools in parallel?

CrewAI agents execute tool calls sequentially within a single reasoning step. However, you can run multiple agents in parallel using process=Process.parallel, each calling different MCP tools concurrently. This is ideal for workflows where separate data sources need to be queried simultaneously.

Can I run CrewAI crews on a schedule (cron)?

Yes. CrewAI crews are standard Python scripts, so you can invoke them via cron, Airflow, Celery, or any task scheduler. The crew.kickoff() method runs synchronously by default, making it straightforward to integrate into existing pipelines.