ReadMe
API documentation platform with interactive developer hubs
Tools
| Name | Description |
|---|---|
create_docCreate a new documentation page | Create a new documentation page |
get_docGet a documentation page by slug | Get a documentation page by slug |
list_categoriesList all documentation categories | List all documentation categories |
get_api_specGet uploaded API specifications | Get uploaded API specifications |
custom_api_callMake a custom API call to the ReadMe API | Make a custom API call to the ReadMe API |
Triggers
| Name | Description |
|---|---|
doc_updatedTriggers when a documentation page is updated | Triggers when a documentation page is updated |
Quick Start
import { WeavzClient } from '@weavz-io/sdk'
const weavz = new WeavzClient({ apiKey: 'wvz_...' })
const result = await weavz.actions.execute('readme-io', 'create_doc', {
workspaceId: '550e8400-e29b-41d4-a716-446655440000',
integrationAlias: 'readme-io',
input: { /* ... */ },
})Related Integrations
Works well with
Frequently Asked Questions
How do I connect ReadMe to my app?
Use Weavz Hosted Connect for Basic Auth authentication. Install the SDK, create a connection through the connect portal or API, then execute tools programmatically.
What tools does ReadMe support?
ReadMe supports 5 tools including Create Doc, Get Doc, List Categories, Get API Specification, Custom API Call.
Can I use ReadMe with AI agents?
Yes. Add ReadMe to an MCP server in Tool Mode or Code Mode. Code Mode provides 3 meta-tools with on-demand API discovery so agents can compose stateful workflows without loading every action schema up front.
How do I connect ReadMe to ChatGPT or Claude?
Open the Weavz connector setup, sign in, choose a workspace, and add ReadMe as an approved app. ChatGPT, Claude, and other remote MCP clients can then call the scoped ReadMe tools exposed by that workspace.
Does ReadMe work with Claude Code, Cursor, Codex, and local agents?
Yes. Remote and local MCP clients can connect to a Weavz MCP endpoint for the workspace. Local coding agents can also use the Weavz CLI to inspect apps, discover actions, run approved ReadMe work, and execute Code Mode workflows from a terminal.
What can I ask an AI agent to do with ReadMe?
ReadMe exposes 5 tools, including Create Doc, Get Doc, List Categories, Get API Specification, Custom API Call. Use Weavz to keep credentials scoped, require approval for sensitive work, and audit what the agent did.
Can ReadMe be used in stateful agent workflows?
Yes. Agents can combine ReadMe tools with Filesystem, State KV, Human Gates, input partials, and other workspace integrations while keeping execution scoped to the selected workspace or end user.
What authentication does ReadMe use?
ReadMe uses Basic Auth. Weavz stores credentials securely and uses them for authorized action execution.
How much does the ReadMe integration cost?
The ReadMe integration is included on all Weavz plans including the free tier with 20,000 actions per month. No credit card required.
What triggers does ReadMe support?
ReadMe supports 1 triggers including Doc Updated.
Connect ReadMe in minutes
Get 20,000 free action executions every month. No credit card required.