Bring Api Documentation
to CrewAI
Create your Vinkius account to connect ReadMe to CrewAI and start using all 10 AI tools in minutes. Fully managed, enterprise secure, and ready to use without writing a single line of code. No hosting, no server setup — just connect and start using.
GDPR Free for SubscribersCompatible with every major AI agent and IDE
Gemini
What is the 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.
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.
How it works
- Authorize the ReadMe MCP server in your environment.
- Provide your ReadMe API Key (found under your project's Configuration settings).
- Ask your AI to summarize a specific API endpoint's documentation or list recent changelogs directly from your chat.
Who is this for?
- Developer Advocates — Verify the accuracy of published guides and quickly draft new content referencing existing structures.
- Technical Writers — Search and audit current documentation for outdated references without leaving your code editor.
- Software Engineers — Instantly pull your company's official API documentation into your IDE to ensure your code aligns with published standards.
Built-in capabilities (10)
Retrieves details for a specific documentation category
Lists all documentation pages under a specific category
Retrieves the full content of a specific changelog post
Retrieves the full content of a custom page
Retrieves the full content of a documentation page
Retrieves details about the ReadMe project
Lists all documentation categories on ReadMe
Lists all changelog posts
Lists all custom standalone pages
Performs a full-text search across all documentation pages
Why CrewAI?
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.
- —
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
mcpsparameter 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 in CrewAI
Why run ReadMe with Vinkius?
The ReadMe connection runs on our fully managed, secure cloud infrastructure. We handle the hosting, maintenance, and security so you don't have to deal with servers or code. All 10 tools are ready to work instantly without any complex setup.
You stay in complete control of your data. Your AI only accesses the information you approve, keeping your sensitive passwords and private details completely safe. Plus, with automatic optimizations, your AI works faster and more efficiently.
* Every connection is hosted and maintained by Vinkius. We handle the security, updates, and infrastructure so you don't have to write code or manage servers. See our infrastructure
Over 4,000 integrations ready for AI agents
Explore a vast library of pre-built integrations, optimized and ready to deploy.
Connect securely in under 30 seconds
Generate tokens to authenticate and link external services in a single step.
Complete visibility into every agent action
Audit live requests, latency, success rates, and active security compliance policies.
Optimize spending and track token ROI
Analyze real-time token consumption and cost metrics detailed by connection.
Explore our live AI Agents Analytics dashboard to see it all working
This dashboard is included when you connect ReadMe using Vinkius. You will never be left in the dark about what your AI agents are doing with your tools.
ReadMe and 4,000+ other AI tools. No hosting, no code, ready to use.
Professionals who connect ReadMe to CrewAI through Vinkius don't need to write code, manage servers, or worry about security. Everything is pre-configured, secure, and runs automatically in the background.
Raw MCP | Vinkius | |
|---|---|---|
| Ready-to-use MCPs | Find and configure each manually | 4,000+ MCPs ready to use |
| Connection Setup | Manual coding & server setup | 1-click instant connection |
| Server Hosting | You host it yourself (needs 24/7 uptime) | 100% hosted & managed by Vinkius |
| Security & Privacy | Stored in plaintext config files | Bank-grade encrypted vault |
| Activity Visibility | Blind execution (no logs or tracking) | Live dashboard with real-time logs |
| Cost Control | Runaway AI token spend risk | Automatic budget limits |
| Revoking Access | Must delete files or code to stop | 1-click disconnect button |
How Vinkius secures
ReadMe for CrewAI
Every request between CrewAI and ReadMe is protected by our secure gateway. We automatically keep your sensitive data private, prevent unauthorized access, and let you disconnect instantly at any time.
Frequently asked questions
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.
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.
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.
Explore More MCP Servers
View all →
TeamGantt
12 toolsPlan projects with intuitive Gantt charts that show deadlines, dependencies, and team workloads in one visual timeline.
SAP Concur
9 toolsEnable your AI agent to manage corporate expenses, track report statuses, and retrieve user profiles via the SAP Concur API.
ClickFunnels
8 toolsManage sales funnels and contacts via ClickFunnels 2.0 — track performance, monitor leads, and manage orders directly from any AI agent.
Winston AI
11 toolsDetect AI-generated content in essays, articles, and documents with high accuracy for educational institutions and publishers.