ReadMe
ReadMe · Files and docs
Developer documentation hubs: docs, API reference and changelogs
The client pastes their API key from ReadMe's settings. We store it encrypted.
Tested against ReadMe's live API.
Tools
Every tool your agent gets for ReadMe. Select one to see its inputs and an example call.
- Loading every tool…
Building with ReadMe? The docs have setup steps and code for every tool.
Open the ReadMe docsAny other endpoint
The request tool calls any ReadMe endpoint the tools above don't cover, with the client's access attached.
Base URL for request
https://dash.readme.com/api/v1
request
HTTPS ANY /v1/clients/{clientId}/readme/{path}
Any endpoint of ReadMe's own API, with the client's access attached.
- servicestringrequired
- This service: readme
- methodstringrequired
- GET, POST, PUT, PATCH or DELETE
- pathstringrequired
- The path under https://dash.readme.com/api/v1
- queryobjectoptional
- Query parameters
- bodyobjectoptional
- A JSON body
Over MCP every tool also takes client_id, from list_clients. Over HTTPS send it as clientId to https://api.operate.as/v1.
What the client approves
- Use the ReadMe key you paste, with only the access you gave that key
Get started
Send your next client one link
Add a client, select the services, copy the link. You'll get an email the moment their access is ready. Start free, no card required. Paid plans are one flat monthly price, and a busy month never takes your agents offline.