The ReadMe MCP server lets your AIML.chat agents search your ReadMe API reference and guides so every answer stays grounded in your published documentation — read-focused, with any write behind human approval. It installs from the MCP marketplace in a few clicks and keeps your technical agent in sync with your docs.
What your agents can do with ReadMe
Once connected, a technical agent can answer developer questions directly from your ReadMe-hosted API reference and guides, returning the relevant section and citing the page so the reader can verify it. Because the content comes straight from your published docs, answers track what you've actually shipped rather than a stale snapshot. When your ReadMe project supports suggested edits, the agent can draft a doc improvement, but that — like any write — waits for human approval. Reads happen automatically; anything that writes runs through AIML.chat's write-confirm flow. Grounded in your own content, the agent gives precise, cited answers, and the analytics surface the questions your docs miss so you know what to write next.
Tools this MCP server exposes
The ReadMe MCP server exposes read tools — search docs and reference, read a page, list categories — and optional write tools where supported, such as drafting a suggested edit. You decide which tools each agent may use and scope the connection to least privilege. Read-only tools are safe to enable broadly; any write tool requires approval, so your published docs are never changed without sign-off.
Connect it in three steps
- 1In AIML.chat, open MCP → Marketplace → ReadMe and click Install.
- 2Authorize with ReadMe (API key) and scope access to the right project.
- 3Attach the ReadMe tools to your technical agent and test: ask it a question your reference answers and confirm it cites the page.
Most teams use read-only tools to keep answers grounded, enabling any write tool only behind the approval flow. You start on a real free tier and scale as usage grows — see pricing for the agent and message limits, and the MCP docs for how write-confirm works. When you're ready, start free.
Will it change my published docs?+
No. Reads are automatic, and any write — like a suggested edit — requires human approval first.
What can the agent do with ReadMe?+
Search and read your API reference and guides and answer with citations, plus draft edits where supported (with approval).
Is there a free plan?+
Yes — start on the free tier. See pricing for higher agent and message limits.